Skip to main content
PATCH
/
v4
/
knowledge-bases
/
{knowledge_base_id}
/
artifacts
/
{artifact_id}
Python
import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
artifact = client.knowledge_bases.artifacts.update(
    artifact_id="artifact_id",
    knowledge_base_id="knowledge_base_id",
)
print(artifact.knowledge_base_id)
{
  "knowledge_base_id": "<string>",
  "artifact_name": "<string>",
  "artifact_uri": "<string>",
  "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>",
  "deleted_at": "<string>",
  "tags": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string | null

Path Parameters

​
knowledge_base_id
string
required
​
artifact_id
string
required

Body

application/json
​
tags
Tags · object

Tags to associate with the artifact. Will overwrite existing tags.

Response

Successful Response

​
knowledge_base_id
string
required
​
artifact_name
string
required
​
artifact_uri
string
required
​
source
enum<string>
required
Available options:
S3,
SharePoint,
SharePointPage,
LocalFile,
LocalChunks,
GoogleDrive,
AzureBlobStorage,
GoogleCloudStorage,
Confluence,
Slack,
Snowflake,
Databricks,
SQLDatabase,
MongoDB,
BigQuery
​
status
enum<string>
required
Available options:
Pending,
Chunking,
Uploading,
Completed,
Failed,
Deleting,
Canceled,
Embedding
​
created_at
required
​
updated_at
required
​
artifact_id
string
​
chunking_strategy_config
CharacterChunkingStrategyConfig · object
​
artifact_uri_public
string
​
content_modification_identifier
string
​
status_reason
string
​
checkpoint
enum<string>
Available options:
Pending,
Chunking,
Uploading,
Completed,
Failed,
Deleting,
Canceled,
Embedding
​
deleted_at
​
tags
Tags · object