ナレッジベース(新版)
ナレッジベースを作成
POST /api/v1/knowledge-bases/
リクエストボディ
リクエストパラメータ
embeddingModel
string (uuid)
はい
rerankerModel
string (uuid)
はい
name
string
はい
description
string
いいえ
numberOfRetrievedChunks
integer
いいえ
取得する参考チャンクの数です。デフォルトは 12、最小値は 1 です
enableHyde
boolean
いいえ
HyDE を有効にします。デフォルトは False です
similarityCutoff
number (double)
いいえ
類似度のしきい値です。デフォルトは 0.0、範囲は 0.0-1.0 です
enableRerank
boolean
いいえ
リランキングを有効にするかどうかを指定します。デフォルトは True です
enableRrf
boolean
いいえ
Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license. If not provided, uses system default.
vectorDatabaseType
object
いいえ
Type of vector database: elasticsearch, opensearch, oracle or synxdb. Defaults to the platform-managed engine. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database ...
vectorDatabaseUrl
string
いいえ
Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey
string
いいえ
API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername
string
いいえ
Username for OpenSearch Basic Auth.
opensearchPassword
string
いいえ
Password for OpenSearch Basic Auth.
oracleUser
string
いいえ
Oracle database username.
oraclePassword
string
いいえ
Oracle database password.
synxdbUser
string
いいえ
SynxDB database username.
synxdbPassword
string
いいえ
SynxDB database password.
chatbots
array[IdName]
いいえ
groups
array[IdName]
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 201
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
すべてのナレッジベースを一覧表示
GET /api/v1/knowledge-bases/
パラメータ
embeddingModel
❌
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
rerankerModel
❌
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定のナレッジベースの詳細を取得
GET /api/v1/knowledge-bases/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定のナレッジベースのコンテンツを検索
POST /api/v1/knowledge-bases/{id}/search/
パラメーター
id
✅
string
A UUID string identifying this Knowledge Base.
embeddingModel
❌
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
rerankerModel
❌
string
リクエストボディ
リクエストパラメーター
searchMode
object
いいえ
Search mode: hybrid (default, vector + BM25), semantic (vector only), keyword (BM25 only) hybrid: Hybrid (vector + BM25) ; semantic: Semantic (vector only) ; keyword: Keyword (BM25 only);
queryMetadata
object
いいえ
検索範囲と方法を制御するためのクエリメタデータ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンス内容
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベースを更新
PUT /api/v1/knowledge-bases/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
リクエストボディ
リクエストパラメータ
organization
string (uuid)
いいえ
embeddingModel
string (uuid)
はい
rerankerModel
string (uuid)
はい
name
string
はい
description
string
いいえ
numberOfRetrievedChunks
integer
いいえ
取得する参考チャンクの数です。デフォルトは 12、最小値は 1 です
enableHyde
boolean
いいえ
HyDE を有効にします。デフォルトは False です
similarityCutoff
number (double)
いいえ
類似度のしきい値です。デフォルトは 0.0、範囲は 0.0-1.0 です
enableRerank
boolean
いいえ
リランキングを有効にするかどうかを指定します。デフォルトは True です
enableRrf
boolean
いいえ
Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license.
vectorDatabaseType
object
いいえ
Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai ; synxdb: SynxDB;
vectorDatabaseUrl
string
いいえ
Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey
string
いいえ
API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername
string
いいえ
Username for OpenSearch Basic Auth.
opensearchPassword
string
いいえ
Password for OpenSearch Basic Auth.
oracleUser
string
いいえ
Oracle database username.
oraclePassword
string
いいえ
Oracle database password.
synxdbUser
string
いいえ
SynxDB database username.
synxdbPassword
string
いいえ
SynxDB database password.
chatbots
array[IdName]
いいえ
groups
array[IdName]
いいえ
ナレッジベースがアクセスできるグループの一覧です
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベースの部分更新
PATCH /api/v1/knowledge-bases/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
リクエストボディ
リクエストパラメータ
organization
string (uuid)
いいえ
embeddingModel
string (uuid)
いいえ
rerankerModel
string (uuid)
いいえ
name
string
いいえ
description
string
いいえ
numberOfRetrievedChunks
integer
いいえ
取得する参照チャンクの数です。デフォルトは 12、最小値は 1 です
enableHyde
boolean
いいえ
HyDE を有効にします。デフォルトは False です
similarityCutoff
number (double)
いいえ
類似度のしきい値です。デフォルトは 0.0、範囲は 0.0〜1.0 です
enableRerank
boolean
いいえ
リランキングを有効にするかどうかです。デフォルトは True です
enableRrf
boolean
いいえ
Enable Reciprocal Rank Fusion for hybrid search. Disable this if using a custom Elasticsearch without enterprise license.
vectorDatabaseType
object
いいえ
Type of vector database: elasticsearch or opensearch. elasticsearch: Elasticsearch ; opensearch: OpenSearch ; oracle: Oracle AI Database 26ai ; synxdb: SynxDB;
vectorDatabaseUrl
string
いいえ
Custom vector database endpoint URL or Oracle DSN. For Elasticsearch/OpenSearch: URL format (e.g., "https://host:9200"). For Oracle: DSN format (e.g., "host:1521/service_name").
vectorDatabaseApiKey
string
いいえ
API Key for Elasticsearch. Not used for OpenSearch.
opensearchUsername
string
いいえ
Username for OpenSearch Basic Auth.
opensearchPassword
string
いいえ
Password for OpenSearch Basic Auth.
oracleUser
string
いいえ
Oracle database username.
oraclePassword
string
いいえ
Oracle database password.
synxdbUser
string
いいえ
SynxDB database username.
synxdbPassword
string
いいえ
SynxDB database password.
chatbots
array[IdName]
いいえ
groups
array[IdName]
いいえ
ナレッジベースにアクセスできるグループの一覧
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベースの削除
DELETE /api/v1/knowledge-bases/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
204
No response body
4XX
Error response; X-Error-Code carries its code (see "Error codes").
RRF の可用性を確認
GET /api/v1/knowledge-bases/{id}/check-rrf-availability/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ラベルの Excel エクスポート
GET /api/v1/knowledge-bases/{id}/export-labels-excel/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
200
Excel file download
4XX
Error response; X-Error-Code carries its code (see "Error codes").
ラベルの Excel インポート
POST /api/v1/knowledge-bases/{id}/import-labels-excel/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
メタデータの Excel エクスポート
GET /api/v1/knowledge-bases/{id}/export-metadata-excel/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
200
Excel ファイルのダウンロード
4XX
Error response; X-Error-Code carries its code (see "Error codes").
メタデータの Excel インポート
POST /api/v1/knowledge-bases/{id}/import-metadata-excel/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
新しいラベルの作成
POST /api/v1/knowledge-bases/{knowledgeBasePk}/labels/
パラメータ
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
name
string
はい
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 201
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベース内のラベル一覧
GET /api/v1/knowledge-bases/{knowledgeBasePk}/labels/
パラメータ
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定のラベルの詳細を取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/
パラメータ
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ラベルの更新
PUT /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/
パラメータ
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
name
string
はい
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ラベルの部分更新
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/
パラメータ
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
name
string
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ラベルの削除
DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/labels/{id}/
パラメータ
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
204
No response body
4XX
Error response; X-Error-Code carries its code (see "Error codes").
メタデータフィールドの作成
POST /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/
パラメータ
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
keyName
string
はい
Metadata key name
description
string
いいえ
What this column is used for
isRequired
boolean
いいえ
Whether this column is required
defaultValue
string
いいえ
Default value for new files
enabledForSearch
boolean
いいえ
Whether this field is used during retrieval
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 201
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
メタデータフィールドの一覧取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/
パラメータ
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
pagination
❌
boolean
Set to false to return all keys without pagination (defaults to true).
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定のメタデータフィールドの取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}/
パラメータ
id
✅
string
A UUID string identifying this Metadata Key.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
メタデータフィールドの更新
PUT /api/v1/knowledge-bases/{knowledgeBasePk}/metadata-keys/{id}/
パラメータ
id
✅
string
A UUID string identifying this Metadata Key.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
keyName
string
はい
Metadata key name
description
string
いいえ
What this column is used for
isRequired
boolean
いいえ
Whether this column is required
defaultValue
string
いいえ
Default value for new files
enabledForSearch
boolean
いいえ
Whether this field is used during retrieval
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベースにファイルをアップロード
POST /api/v1/knowledge-bases/{knowledgeBasePk}/files/
パラメータ
knowledgeBasePk
✅
string
fileType
❌
string
ファイルタイプによる絞り込み。例:pdf、docx、txt、xlsx など
knowledgeBase
❌
string
ナレッジベース ID
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
検索キーワード。スペース区切りで複数条件の検索ができます。検索対象:ファイル ID、ファイル名、ラベル名、Metadata の値
status
❌
string
ファイルのステータスによる絞り込み。指定可能な値:initial(初期化)、processing(処理中)、done(完了)、deleting(削除中)、deleted(削除済み)、failed(失敗) `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...
リクエストボディ
リクエストパラメータ
files
array[KnowledgeBaseFileCreate]
はい
Supports uploading multiple files in one batch.
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 201
レスポンススキーマの例
レスポンスの値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルのメタデータを更新
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/update-metadata/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンスの値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルの一括削除
POST /api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-delete/
パラメータ
knowledgeBasePk
✅
string
リクエスト内容
リクエストパラメータ
purgeCitations
boolean
いいえ
ids
array[string]
はい
リクエストスキーマの例
リクエストのサンプル値
コード例
レスポンス内容
ステータスコード: 200
レスポンス構造の例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルの一括再解析
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/files/batch-reparse/
パラメータ
knowledgeBasePk
✅
string
fileType
❌
string
ファイルタイプによる絞り込みです。例:pdf、docx、txt、xlsx など
knowledgeBase
❌
string
ナレッジベース ID
query
❌
string
検索キーワードです。空白区切りの複数条件検索に対応しています。検索対象:ファイル ID、ファイル名、ラベル名、メタデータの値
status
❌
string
ファイルのステータスによる絞り込みです。指定できる値:initial(初期化)、processing(処理中)、done(完了)、deleting(削除中)、deleted(削除済み)、failed(失敗) `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...
コード例
{% tabs %} {% tab title="Shell/Bash" %}
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベース内のファイル一覧の取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/
パラメータ
knowledgeBasePk
✅
string
fileType
❌
string
ファイルタイプによる絞り込みです。例:pdf、docx、txt、xlsx など
knowledgeBase
❌
string
ナレッジベース ID
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
検索キーワードです。空白区切りの複数条件検索に対応しています。検索対象:ファイル ID、ファイル名、ラベル名、メタデータの値
status
❌
string
ファイルのステータスによる絞り込みです。指定できる値:initial(初期化)、processing(処理中)、done(完了)、deleting(削除中)、deleted(削除済み)、failed(失敗) `initial`: Initial ; `processing`: Processing ; `done`: Done ; `deleting`: Deleting ; `deleted`: Deleted ; `faile...
コード例
{% tabs %} {% tab title="Shell/Bash" %}
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定のファイルの詳細の取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルの最新の失敗理由を取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/latest-failed-reason/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルの文字起こし内容の取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/transcription/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイル情報の更新
PUT /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
filename
string
はい
ファイル名
file
string (uri)
はい
アップロードするファイル
parser
string (uuid)
いいえ
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
asrOptions
object
いいえ
Per-file canonical transcription options (languages, prompt, diarization). Empty means no per-file options: provider defaults apply. Completely decoupled from user-defined metadata; never indexed for ...
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルの部分更新
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
filename
string
いいえ
ファイル名
file
string (uri)
いいえ
アップロードするファイル
parser
string (uuid)
いいえ
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
asrOptions
object
いいえ
Per-file canonical transcription options (languages, prompt, diarization). Empty means no per-file options: provider defaults apply. Completely decoupled from user-defined metadata; never indexed for ...
リクエストスキーマの例
リクエスト値の例
コード例
レスポンス内容
ステータスコード: 200
レスポンス構造の例
レスポンスの値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイルを削除
DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/files/{id}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base File.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 202
レスポンススキーマの例
レスポンス値の例
ステータスコード: 204 - No response body
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイル翻訳の作成
POST /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/
パラメータ
knowledgeBaseFilePk
✅
string
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
sourceLanguage
string
いいえ
targetLanguage
string
はい
customPrompt
string
いいえ
largeLanguageModelId
string (uuid)
はい
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 201
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ファイル翻訳の一覧取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/
パラメータ
knowledgeBaseFilePk
✅
string
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
コード例
レスポンス内容
ステータスコード: 200
レスポンス構造の例
レスポンス例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定の翻訳の取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/
パラメータ
id
✅
string
A UUID string identifying this File Translation.
knowledgeBaseFilePk
✅
string
knowledgeBasePk
✅
string
コード例
レスポンス内容
ステータスコード: 200
レスポンス構造の例
レスポンス例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
翻訳の削除
DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/
パラメータ
id
✅
string
A UUID string identifying this File Translation.
knowledgeBaseFilePk
✅
string
knowledgeBasePk
✅
string
コード例
レスポンスボディ
204
No response body
4XX
Error response; X-Error-Code carries its code (see "Error codes").
翻訳ファイルのダウンロード
GET /api/v1/knowledge-bases/{knowledgeBasePk}/files/{knowledgeBaseFilePk}/translations/{id}/download/
パラメータ
id
✅
string
A UUID string identifying this File Translation.
knowledgeBaseFilePk
✅
string
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ナレッジベースのドキュメント一覧を取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/documents/
パラメーター
knowledgeBasePk
✅
string
chatbotFileId
❌
string
【廃止予定】ファイル ID(knowledge_base_file_id を使用してください)
knowledgeBaseFileId
❌
string
ナレッジベースのファイル ID
コード例
レスポンス内容
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 404 - ナレッジベースのファイルが存在しないか、現在の組織に属していません
ドキュメントを更新
PUT /api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}/
パラメータ
id
✅
string
A UUID string identifying this Chatbot Document.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
fileName
string
はい
pageNumber
integer
いいえ
chatbotFile
string (uuid)
はい
excludedEmbedMetadataKeys
object
いいえ
List[str]: metadata keys to exclude from the embedding.
excludedLlmMetadataKeys
object
いいえ
List[str]: metadata keys to exclude from the LLM context.
llamaIndexObjectJson
object
いいえ
metadata
object
いいえ
text
string
はい
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ドキュメントを部分更新
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}/
パラメータ
id
✅
string
A UUID string identifying this Chatbot Document.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
fileName
string
いいえ
pageNumber
integer
いいえ
chatbotFile
string (uuid)
いいえ
excludedEmbedMetadataKeys
object
いいえ
List[str]: metadata keys to exclude from the embedding.
excludedLlmMetadataKeys
object
いいえ
List[str]: metadata keys to exclude from the LLM context.
llamaIndexObjectJson
object
いいえ
metadata
object
いいえ
text
string
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
ドキュメントを削除
DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/documents/{id}/
パラメータ
id
✅
string
A UUID string identifying this Chatbot Document.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
204
No response body
4XX
Error response; X-Error-Code carries its code (see "Error codes").
新しい FAQ を作成
POST /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/
パラメータ
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
question
string
はい
answer
string
はい
answerMediaUrls
object
いいえ
URLs of media files, such as images and videos, in the answer.
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 201
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
FAQ メタデータを更新
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/update-metadata/
パラメータ
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
FAQ を一括削除
POST /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete/
パラメータ
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
ids
array[string]
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
204
No response body
4XX
Error response; X-Error-Code carries its code (see "Error codes").
特定のナレッジベースのすべての FAQ を一覧表示
GET /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/
パラメータ
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
検索キーワードです。スペース区切りで複数の条件を指定できます。検索対象:FAQ ID、質問、回答、ラベル名、Metadata value
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定の FAQ の詳細を取得
GET /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
パラメータ
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
FAQ を更新
PUT /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
パラメータ
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
question
string
はい
answer
string
はい
answerMediaUrls
object
いいえ
URLs of media files, such as images and videos, in the answer.
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
FAQ を部分更新
PATCH /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
パラメータ
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
リクエストボディ
リクエストパラメータ
question
string
いいえ
answer
string
いいえ
answerMediaUrls
object
いいえ
URLs of media files, such as images and videos, in the answer.
labels
array[IdName]
いいえ
rawUserDefineMetadata
object
いいえ
リクエストスキーマの例
リクエスト値の例
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
FAQ を削除
DELETE /api/v1/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
パラメータ
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
コード例
レスポンスボディ
204
No response body
4XX
Error response; X-Error-Code carries its code (see "Error codes").
FAQ Excel をエクスポート(または空のテンプレート)
GET /api/v1/knowledge-bases/{id}/export-faq-excel/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンスボディ
ステータスコード: 200
レスポンススキーマの例
レスポンス値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
FAQ Excel のインポート(非同期)
POST /api/v1/knowledge-bases/{id}/import-faq-excel/
パラメーター
id
✅
string
A UUID string identifying this Knowledge Base.
コード例
レスポンス内容
ステータスコード: 202
レスポンススキーマの例
レスポンスの値の例
ステータスコード: 409
レスポンススキーマの例
レスポンスの値の例
FAQ インポートジョブの一覧取得
GET /api/v1/knowledge-bases/{id}/faq-import-jobs/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
embeddingModel
❌
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
pagination
❌
boolean
Set to false to return all jobs without pagination (defaults to true).
query
❌
string
rerankerModel
❌
string
コード例
レスポンス内容
ステータスコード: 200
レスポンススキーマの例
レスポンスの値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
特定の FAQ インポートジョブの取得
GET /api/v1/knowledge-bases/{id}/faq-import-jobs/{jobId}/
パラメータ
id
✅
string
A UUID string identifying this Knowledge Base.
jobId
✅
string
コード例
レスポンス内容
ステータスコード: 200
レスポンススキーマの例
レスポンスの値の例
ステータスコード: 4XX - Error response; X-Error-Code carries its code (see "Error codes").
パーサーの一覧取得
GET /api/v1/parsers/
コード例
レスポンス内容
ステータスコード: 200
レスポンススキーマの例
レスポンスの値の例
特定のパーサーの取得
GET /api/v1/parsers/{id}/
パラメータ
id
✅
string
A UUID string identifying this Parser.
コード例
レスポンス内容
ステータスコード: 200
レスポンススキーマの例
レスポンスの値の例
最終更新
役に立ちましたか?