Calibration groups
This page helps understand how to create new calibration groups, modify existing ones, and fetch all the existing ones from a workspace.
Quickstart
Before invoking the APIs, the client must obtain the clientId and auth token from Deepen AI. If you are a calibration admin, you can create different Access Tokens using the UI and use those instead. clientId is part of the path parameters in most API calls, and the auth token should be prefixed with “Bearer “ and passed to the ‘Authorization’ header in all API requests. How to get Access Tokens can be found on the following link: Access token for APIs
Create a new Calibration Group
This POST api sends the user-provided calibration group name to the server to create a new calibration group and returns calibration_group_name and calibration_group_id.
https://tools.calibrate.deepen.ai/api/v2/external/clients/{clientId}/calibration_group/create
Request
Path parameters
Parameter name | Parameter type | Description |
---|---|---|
clientId | string | ClientId obtained from Deepen AI |
Body
Key | Value | Description |
---|---|---|
calibration_group_name | string | Name of the calibration group |
Response
Key | Description |
---|---|
calibration_group_name | Name of the calibration group created |
calibration_group_id | A unique value to identify the calibration group. calibration_group_id can be used to add new datasets to the group. |
Code snippets
Python
cURL
Modify existing Calibration Group
This POST api updated the name of the calibration group associated with the calibration_group_id and returns calibration_group_name, calibration_group_id, and calibration_ids
https://tools.calibrate.deepen.ai/api/v2/external/clients/{clientId}/calibration_group/modify
Request
Path parameters
Parameter name | Parameter type | Description |
---|---|---|
clientId | string | ClientId obtained from Deepen AI |
Body
Key | Value | Description |
---|---|---|
calibration_group_id | string | Id of the calibration group to update |
calibration_group_name | string | New name for the calibration group associated with the calibration_group_id |
Response
Key | Description |
---|---|
calibration_group_name | Updated name of the calibration group associated with the provided calibration_group_id |
calibration_group_id | Data provided by the user in the request. |
calibration_ids | List of calibrations (datasets) in the calibration group with the user-provided calibration_group_id in the request. |
Code snippets
Python
cURL
Fetch existing calibration group details
This GET api fetches existing calibration group details. Returns list of groups with details calibration_group_id, calibration_group_name and calibration_ids
https://tools.calibrate.deepen.ai/api/v2/external/clients/{client_id}/calibration_groups
Request
Path parameters
Parameter name | Parameter type | Description |
---|---|---|
clientId | string | ClientId obtained from Deepen AI |
Response
Key | Description |
---|---|
calibration_group_name | Name of the calibration group |
calibration_group_id | A unique value to identify the calibration group. calibration_group_id can be used to add new datasets to the group. |
calibration_ids | List of calibrations (datasets) in the calibration group for the corresponding calibration_group_id. |
Code snippets
Python
cURL
Last updated