IvyCheck Python Client SDK
Project description
IvyCheck Python SDK
SDK Installation
pip install ivycheck
SDK Example Usage
Example
import ivycheck
ivy = ivycheck.IvyCheck(
api_key="<YOUR_TOKEN_HERE>",
)
ivy.checks.hallucination(text="It is sunny outside", context="It is rainig cats and dogs")
# {'passed': False,
# 'score': 0.0003337860107421875,
# 'message': 'Hallucination detected',
# 'findings': None,
# 'sanitized_output': None}
Available Resources and Operations
Checks
- hallucination - Hallucination
- pii - Pii
- prompt_injection - Prompt Injection
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
ivy = ivycheck.IvyCheck(
api_key="<YOUR_BEARER_TOKEN_HERE>",
)
res = ivy.checks.hallucination(response='<value>', context='<value>', project_id='<value>')
if res.check_result is not None:
# handle response
pass
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
ivycheck-0.10.0.tar.gz
(3.4 kB
view hashes)
Built Distribution
Close
Hashes for ivycheck-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f42e7bb923fbb92ad92f947e7e208d5868763777e6edec708f67de80fa790e74 |
|
MD5 | c498ca0d1714d0c152be900b5fac1286 |
|
BLAKE2b-256 | 3692f9105b53c37139b59aede3c46f419648929419991df49536d9e7eab46a61 |