import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const chunkListResponse of client.knowledgeBases.artifacts.chunks.list(
'knowledge_base_id',
'artifact_id',
)) {
console.log(chunkListResponse.id);
}
{
"items": [
{
"id": "<string>",
"text": "<string>",
"artifact_id": "<string>",
"chunk_position": 123,
"metadata": {},
"user_supplied_metadata": {},
"status": "Pending",
"status_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
List chunks for a specific artifact. This API supports pagination and reads only from the data store to allow querying chunks that are failed as well to enumerate all chunks of a specific artifact.
import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
// Automatically fetches more pages as needed.
for await (const chunkListResponse of client.knowledgeBases.artifacts.chunks.list(
'knowledge_base_id',
'artifact_id',
)) {
console.log(chunkListResponse.id);
}
{
"items": [
{
"id": "<string>",
"text": "<string>",
"artifact_id": "<string>",
"chunk_position": 123,
"metadata": {},
"user_supplied_metadata": {},
"status": "Pending",
"status_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"total_item_count": 123,
"current_page": 123,
"items_per_page": 123
}
Filter by the status of the chunks
Pending
, Completed
, Failed
Page number for pagination to be returned by the given endpoint. Starts at page 1
x >= 1
Maximum number of artifacts to be returned by the given endpoint. Defaults to 100 and cannot be greater than 10k.
1 <= x <= 10000
Successful Response
The response is of type object
.