Client
client ¶
bi_sdk.client.BlindInsightClient ¶
A porcelain client wrapping the OpenAPI REST client for the BlindInsight HTTP API.
check_auth_credentials ¶
Checks for the existence of auth credentials within API client.
check_connection ¶
Checks that we can authenticate to the server with our credentials.
decrypt_data ¶
ingest_data ¶
Ingest data into the server.
See the documentation for
resolve_schema_url
for more information on kwargs that can be used if you don't have the schema_url directly.
Returns:
| Name | Type | Description |
|---|---|---|
data |
list[dict]
|
The ingested data. |
login ¶
proxy_decrypt_data ¶
proxy_ingest_data ¶
proxy_search_data ¶
resolve_schema_url ¶
Resolve the schema URL from the given arguments.
If schema_url is given, it will be used directly.
If dataset_id is given, it will be used with schema_slug to resolve
the schema.
If org_id is given, it will be used with dataset_slug to resolve
the dataset.
If org_slug is given, it will be used to resolve the organization.
For fastest ingestion use schema_url, otherwise additional API call
overhead will be incurred.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
schema_url |
Optional[str]
|
The url of the schema to use. |
required |
org_slug |
Optional[str]
|
The slug of the organization to use. |
required |
org_id |
Optional[str]
|
The id of the organization to use. |
required |
dataset_slug |
Optional[str]
|
The slug of the dataset to use. |
required |
dataset_id |
Optional[str]
|
The id of the dataset to use. |
required |
schema_slug |
Optional[str]
|
The slug of the schema to use. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
schema_url |
str
|
The resolved schema URL. |
search_data ¶
bi_sdk.client.ClientError ¶
Bases: RuntimeError
Raised when the BlindInsightClient encounters an error unrelated to the API.