Platform APIs
- Client libraries
- GETList all knowledge bases
- POSTCreate a knowledge
- GETRetrieves a knowledge base
- DELDeletes a knowledge
- PATCHUpdates a knowledge
- POSTSearch knowledge base
- GETList all datasources
- POSTCreate a new datasource
- GETRetrieve a datasource
- DELDeletes a datasource
- PATCHUpdate a datasource
- GETList all chunks for a datasource
- POSTCreate chunks for a datasource
- DELDelete multiple chunks
- POSTList chunks with offset-based pagination
- POSTGet chunks total count
- GETRetrieve a chunk
- DELDelete a chunk
- PATCHUpdate a chunk
- GET
Gateway APIs
curl --request POST \
--url https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "<string>",
"file_id": "<string>",
"chunking_options": {
"chunking_configuration": {
"type": "default"
},
"chunking_cleanup_options": {
"delete_emails": true,
"delete_credit_cards": true,
"delete_phone_numbers": true,
"clean_bullet_points": true,
"clean_numbered_list": true,
"clean_unicode": true,
"clean_dashes": true,
"clean_whitespaces": true
}
}
}
'{
"display_name": "<string>",
"status": "pending",
"created": "<string>",
"updated": "<string>",
"knowledge_id": "<string>",
"chunks_count": 123,
"_id": "01KBYRE1WP9DX7CXPW2SVBJ882",
"description": "<string>",
"file_id": "<string>",
"created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"update_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Create a new datasource
curl --request POST \
--url https://api.orq.ai/v2/knowledge/{knowledge_id}/datasources \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"display_name": "<string>",
"file_id": "<string>",
"chunking_options": {
"chunking_configuration": {
"type": "default"
},
"chunking_cleanup_options": {
"delete_emails": true,
"delete_credit_cards": true,
"delete_phone_numbers": true,
"clean_bullet_points": true,
"clean_numbered_list": true,
"clean_unicode": true,
"clean_dashes": true,
"clean_whitespaces": true
}
}
}
'{
"display_name": "<string>",
"status": "pending",
"created": "<string>",
"updated": "<string>",
"knowledge_id": "<string>",
"chunks_count": 123,
"_id": "01KBYRE1WP9DX7CXPW2SVBJ882",
"description": "<string>",
"file_id": "<string>",
"created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"update_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier of the knowledge base
Body
The display name for the datasource visible in the UI. If omitted, the display name is derived from the uploaded file. When both display_name and file_id are provided, the provided display_name is prioritized.
The unique identifier of the file used for datasource creation. If provided, the file is immediately queued for chunking.
Configuration options specifying how the datasource file is chunked. Required if file_id is specified. Defaults to standard chunking options if omitted.
Show child attributes
Show child attributes
The chunking configuration settings for the datasource. Defaults to the system's standard chunking configuration if not specified.
- Option 1
- Option 2
Show child attributes
Show child attributes
default The cleanup options applied to the datasource content. All options are enabled by default to ensure enhanced security and optimal chunk quality. Defaults to system-standard cleanup options if not specified.
Show child attributes
Show child attributes
Removes email addresses from the provided text.
Removes credit card numbers from the provided text.
Removes phone numbers from the provided text.
Removes bullet points formatting from the text.
Removes numbered list formatting from the text.
Normalizes or removes unnecessary unicode characters from the text.
Normalizes or removes various dash characters to standardize the text.
Trims and normalizes excessive whitespace throughout the text.
Response
Datasource successfully created
The display name of the datasource. Normally the name of the uploaded file
pending, processing, completed, failed, queued The date and time the datasource was created
The date and time the datasource was updated
The unique identifier of the knowledge base
The number of chunks in the datasource
The unique identifier of the data source
The description of the knowledge base
The unique identifier of the file used to create the datasource.
The user ID of the creator of the knowledge base
The user ID of the last user who updated the knowledge base
Was this page helpful?