Setup: Python SDK Installation & API Key Retrieval

Install the Python SDK in your Development Environment

pip install deepchecks-llm-client

Generate an API Key (via the UI)

As a best practice we recommend that you save this key as an environment variable with the name DEEPCHECKS_API_KEY and retrieve it from there.

os.environ["DEEPCHECKS_API_KEY"] = "key here"

SageMaker Partner AI Apps Usage

Your private Deepchecks LLM installation might not be fully updated to the latest version.
To make sure you are using the right SDK version that correlates with your backend you need to obtain the server version.
You can do that for the UI, under "API Key" tab, from the user profile

Now use the server version information when running pip install command as described below
(SageMaker users, also need to add the [sagemaker] extras when installing the deepchecks SDK)

pip install deepchecks-llm-client[sagemaker]>=major.minor,<major.minor+1
(for instance: pip install deepchecks-llm-client[sagemaker]>=0.23,<0.24)

Before start using the SDK, set those env variables (Instructions to obtain Deepchecks API Key can be found here, the rest of the values need to be obtain from SageMaker marketplace)

os.environ["AWS_PARTNER_APP_AUTH"] = "True"
os.environ["AWS_PARTNER_APP_ARN"] = "arn:aws:sagemaker:xxx"
os.environ["AWS_PARTNER_APP_URL"] = "https://xxx.mlapp.sagemaker.aws"
os.environ["DEEPCHECKS_API_KEY"] = "key here"