Labelling API (1.0)
Download OpenAPI specification:Download
api.auth.get_auth_url_params
Endpoint to request temporary valid parameter for URL that can not be authenticated via headers. Used for download of big files.
Authorizations:
query Parameters
| project_id required | string id of project |
| parameter required | string parameter of the next auth request |
Responses
api.auth.generate_invite_link_params
Get params for invite link generation
Authorizations:
query Parameters
| invite_email required | string email of the invitee |
| new_tennant | string if new user should share tennant with the one who sent the invite |
| user_profile | string parameter of the next auth request |
Responses
api.google_oauth_flow.get_auth_url
Request for google authentication for scenarious where google token needs to be saved on server (BigQuery integration)
Authorizations:
query Parameters
| final_redirect required | string where to next |
| project_id | string id of project to authenicate for |
| reprocess | string where to next |
Responses
api.projects.post
Upsert project
Authorizations:
query Parameters
| download_and_process_data | boolean if project data should be downloaded from source and processed |
| merge_with_new_data | boolean |
Request Body schema: application/json
project data
| id | string |
| name | string |
Responses
Request samples
- Payload
{- "id": "string",
- "name": "string"
}api.projects.apply_labels_from_project
Copy labels from one project to another (match by key)
Authorizations:
path Parameters
| project_id required | string id of project |
query Parameters
| source_project_id required | string id of project |
| missing_label_behaviour required | string one of none | skip | add_to_project |
Responses
api.projects.patch_preferences
Update general lebeling settings for project like similarity threshold
Authorizations:
path Parameters
| project_id required | string |
Request Body schema: application/json
object like {"similarity_threshold":0.8}
Responses
Request samples
- Payload
{ }api.models.create_model_from_upload
get upload url
Authorizations:
path Parameters
| project_id required | string id of project |
query Parameters
| temp_file_path required | string path of files in GPC, retrieved from projects/{project_id}/models/upload/get_url endpoint |
| task_type required | string model task type |
| model_name required | string model name (without project name) |
Responses
api.docs.add_documents
Authorizations:
path Parameters
| project_id required | string |
query Parameters
| upsert | boolean wheter if duplicate key is already in database, it should be overriden... default false |
Request Body schema: application/json
Responses
Request samples
- Payload
[- { }
]api.docs.get_count
Authorizations:
path Parameters
| project_id required | string |
query Parameters
| topic_id | string filter for find only the docs for topic |
| keyword | string keyword to find in all text documents |
| by_label | string filtering by label ... special values - 'null' / '!null' for filtering with any or none label |
| key | string key of document |
| false_positives | string label to search for in falsly positive predicted labels on documents |
| false_negatives | string label to search for in falsly negagtive predicted labels on documents |
| predicted_label | string label that was predicted on document |
| prediction_certainty | string preduction certainty of predicted_label (if number is negative, it's certainty of not predition that label) |
Responses
api.docs.get_similar_count
Authorizations:
path Parameters
| project_id required | string |
| doc_id required | string |
query Parameters
| by_label | string filter for particular label only, or null/!null for filtering out labeled, not labeled |
| limit | number stop condition, max count to be returned |
| min_score | number minimum similarity score to limit to result for simularity based request. Must be number between 0 and 1. |
Responses
api.docs.search
Authorizations:
path Parameters
| project_id required | string |
query Parameters
| topic_id | string filter for find only the docs for topic |
| keyword | string keyword to find in all text documents |
| similar_to_doc | string id of document to search similar docs to |
| similar_to_phrase | string text or phrase to search similar document to |
| min_score | number minimum similarity score to limit to result for simularity based request. Must be number between 0 and 1. |
| by_label | string filtering by label ... special values - 'null' / '!null' for filtering with any or none label |
| key | string key of document |
| false_positives | string label to search for in falsly positive predicted labels on documents |
| false_negatives | string label to search for in falsly negagtive predicted labels on documents |
| predicted_label | string label that was predicted on document |
| prediction_certainty | string preduction certainty of predicted_label (if number is negative, it's certainty of not predition that label) |
| prediction_comparsion | string prediction difference ... with + or - prefix whether new prediciton has extra label |
| order_by | string set the order and order field... for descending fields needs to start with "-"ň |
| after | number get records after provided order number. Order number is a unumber as the records are stored in database |
| before | number get records before provided order number. Order number is a unumber as the records are stored in database |
| skip | integer Default: 0 number of documents to skip in result before fetching |
| take | integer Default: 50 max number of documents to load |
Responses
api.serving.create_node
Authorizations:
Request Body schema: application/json
| node_name | string |
| node_type | string |
| deployment_type | string |
| status | string |
Responses
Request samples
- Payload
{- "node_name": "string",
- "node_type": "string",
- "deployment_type": "string",
- "status": "string"
}api.serving.patch_node_info
Authorizations:
path Parameters
| node_name required | string |
Request Body schema: application/json
| node_name | string |
| node_type | string |
| deployment_type | string |
| status | string |
Responses
Request samples
- Payload
{- "node_name": "string",
- "node_type": "string",
- "deployment_type": "string",
- "status": "string"
}api.integrations.save_settings
Authorizations:
path Parameters
| connector required | string if project data should be downloaded from source and processed |
query Parameters
| project_id | string id of project for which the settings are valid |
Request Body schema: application/json
any settings to be saved to connector
Responses
Request samples
- Payload
{ }api.integrations.put_metadata
Authorizations:
path Parameters
| connector required | string if project data should be downloaded from source and processed |
| key required | string metadata key |
Request Body schema: application/json
any settings to be saved to connector
Responses
Request samples
- Payload
{ }