IvyCheck Python Client SDK
Project description
IvyCheck-SDK
SDK Installation
pip install ivycheck
SDK Example Usage
Example
import ivycheck
ivy = ivycheck.IvyCheck(
api_key="<YOUR_TOKEN_HERE>",
)
res = ivy.checks.hallucination(response="It is sunny outside", context="It is rainig cats and dogs")
# CheckResult(passed=False, score=0.9992709300131537, message='Hallucination detected')
Available Resources and Operations
checks
- hallucination - Hallucination
- pii - Pii
- prompt_injection - Prompt Injection
Error Handling
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
models.HTTPValidationError | 422 | application/json |
models.SDKError | 4xx-5xx | / |
Example
import ivycheck
from ivycheck import models
s = ivycheck.IvyCheck(
api_key="<YOUR_BEARER_TOKEN_HERE>",
)
res = None
try:
res = s.checks.hallucination(response='<value>', context='<value>', project_id='<value>')
except models.HTTPValidationError as e:
# handle exception
raise(e)
except models.SDKError as e:
# handle exception
raise(e)
if res.check_result is not None:
# handle response
pass
Custom HTTP Client
The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session
object.
For example, you could specify a header for every request that this sdk makes as follows:
import ivycheck
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = ivycheck.IvyCheck(client=http_client)
Authentication
Per-Client Security Schemes
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
api_key |
http | HTTP Bearer |
To authenticate with the API the api_key
parameter must be set when initializing the SDK client instance. For example:
import ivycheck
s = ivycheck.IvyCheck(
api_key="<YOUR_BEARER_TOKEN_HERE>",
)
res = s.checks.hallucination(response='<value>', context='<value>', project_id='<value>')
if res.check_result is not None:
# handle response
pass
Development
Maturity
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
Contributions
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!
SDK Created by Speakeasy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ivycheck-0.10.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82616c81777f2635b7640347acf1ee46513e5fae5a5e75e716d3800c3bc93c0a |
|
MD5 | 8b8dd81f44e1d4eda35dafe1782cfd39 |
|
BLAKE2b-256 | eff1e9868154c9895ad007dd001dd6b42351c680869c2e5d5989fe306ec16eeb |