import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const artifact = await client.knowledgeBases.artifacts.update('knowledge_base_id', 'artifact_id');
console.log(artifact.knowledge_base_id);{
"knowledge_base_id": "<string>",
"artifact_name": "<string>",
"artifact_uri": "<string>",
"source": "S3",
"status": "Pending",
"created_at": "<string>",
"updated_at": "<string>",
"artifact_id": "<string>",
"chunking_strategy_config": {
"strategy": "<string>",
"separator": "\n\n",
"chunk_size": 1000,
"chunk_overlap": 200
},
"artifact_uri_public": "<string>",
"content_modification_identifier": "<string>",
"status_reason": "<string>",
"checkpoint": "Pending",
"deleted_at": "<string>",
"tags": {}
}import SGPClient from 'sgp';
const client = new SGPClient({
apiKey: 'My API Key',
});
const artifact = await client.knowledgeBases.artifacts.update('knowledge_base_id', 'artifact_id');
console.log(artifact.knowledge_base_id);{
"knowledge_base_id": "<string>",
"artifact_name": "<string>",
"artifact_uri": "<string>",
"source": "S3",
"status": "Pending",
"created_at": "<string>",
"updated_at": "<string>",
"artifact_id": "<string>",
"chunking_strategy_config": {
"strategy": "<string>",
"separator": "\n\n",
"chunk_size": 1000,
"chunk_overlap": 200
},
"artifact_uri_public": "<string>",
"content_modification_identifier": "<string>",
"status_reason": "<string>",
"checkpoint": "Pending",
"deleted_at": "<string>",
"tags": {}
}Tags to associate with the artifact. Will overwrite existing tags.
Successful Response
S3, SharePoint, SharePointPage, LocalFile, LocalChunks, GoogleDrive, AzureBlobStorage, Confluence, Slack, Snowflake, Databricks Pending, Chunking, Uploading, Completed, Failed, Deleting, Canceled, Embedding Show child attributes
"character"Character designating breaks in input data. Text data will first be split into sections by this separator, then each section will be split into chunks of size chunk_size.
Maximum number of characters in each chunk. If not specified, a chunk size of 1000 will be used.
x >= 1Number of characters to overlap between chunks. If not specified, an overlap of 200 will be used. For example if the chunk size is 3 and the overlap size is 1, and the text to chunk is 'abcde', the chunks will be 'abc', 'cde'.
x >= 0Pending, Chunking, Uploading, Completed, Failed, Deleting, Canceled, Embedding