ドキュメント検索 (document)、データクエリ (table)、またはイメージ Q&A (image) のナレッジベースにチャンクを追加します。
操作説明
- この操作は、ドキュメント検索 (document)、データクエリ (table)、またはイメージ Q&A (image) タイプの指定されたナレッジベースにチャンクコンテンツを追加します。マルチメディア検索 (multimedia) ナレッジベースに対する関連操作はサポートされていません。データクエリおよびイメージ Q&A のナレッジベースの場合、この操作はデータソースがスプレッドシートコネクタ (excel) である場合にのみ効果があります。
- RAM ユーザーはこの操作を呼び出す前に、Model Studio の API 権限 (sfm:ChunkList 権限を含む
AliyunBailianDataFullAccessが必要) を取得し、ワークスペースに参加する必要があります。Alibaba Cloud アカウントは、権限付与なしでこの操作を直接呼び出せます。この操作を呼び出すには、最新の Model Studio SDKModel Studio SDK を使用してください。 - この操作を呼び出す前に、ナレッジベースが作成されており、削除されていないこと (つまり、ナレッジベース ID
IndexIdが有効であること) を確認してください。 - この操作にはべき等性があります。
速度制限: この操作は、頻繁に呼び出されると速度制限の対象となります。毎秒 10 回を超える呼び出しを行わないでください。速度制限を受けた場合は、後でリトライしてください。
今すぐお試しください
この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。
RAM 認証
この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。
リクエスト構文
POST /{WorkspaceId}/chunk/create HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| WorkspaceId | string | 必須 | ワークスペースの ID。 | llm-19hxxxxx7htdf9lh |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| PipelineId | string | 必須 | ナレッジベースの ID。 | 79c0alxxxx |
| dataId | string | 任意 | ファイルの ID。 | doc_xxx |
| field | object | 任意 | 挿入するチャンクコンテンツ。キーと値のペアとして渡されます。ドキュメント検索ナレッジベースの場合は、以下の固定キーリストを使用します。
データクエリおよびイメージ Q&A のナレッジベースの場合、キーは固定されておらず、ナレッジベースのデータソースであるスプレッドシートによって決定されます。キーは Excel の列ヘッダー、値は対応する列の値となります。 | { "content": "The Bailian platform supports parsing multiple document formats including PDF, Word, and PPT.", "title": "Document Parsing and Chunking", "image_urls": [ "https://example.com/images/chunk-flow.png", "https://example.com/images/parsing-result.png" ] } |
any | 任意 | 挿入されるチャンクのヘッダーフィールド情報。データクエリおよびイメージ Q&A のナレッジベースのみがサポートされています。取得または応答生成に参加するヘッダーは必須です。各タイプの値の要件は以下の通りです。
| {"Product Name": "Wireless Bluetooth Headphones", "Publish Time": 1752624000000, "Stock Quantity": 1580, "Unit Price": 299.99, "image_url":"https://example.com/images/headphones-front.jpg,https://example.com/images/headphones-side.jpg,https://example.com/images/headphones-package.jpg" } |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | 応答のスキーマ。 | ||
| RequestId | string | リクエストの ID。 | 35A267BF-xxxx-54DB-8394-AA3B0742D833 |
| Code | string | エラー状態コード。 | Index.InvalidParameter |
| Message | string | エラーメッセージ。 | Required parameter(%s) missing or invalid, please check the request parameters. |
| Success | boolean | 操作が成功したかどうかを示します。 列挙値:
| true |
| Data | boolean | リクエスト成功時に返されるビジネスデータ。 列挙値:
| true |
| Status | string | 操作によって返される状態コード。 | 200 |
例
成功レスポンス
JSONJSON
{
"RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
"Code": "Index.InvalidParameter",
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"Success": true,
"Data": true,
"Status": "200"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。