ドキュメントまたは音声/動画に基づく非構造化ナレッジベース、あるいはデータクエリやイメージベースの Q&A 用の構造化ナレッジベースを作成します。
操作説明
-
権限要件:
- RAM ユーザー: まず Alibaba Cloud Model Studio の API 権限 を取得し(この操作に必須な sfm:CreateIndex 権限を含む
AliyunBailianDataFullAccessポリシーを使用できます)、この操作を呼び出す前に ワークスペースに参加 してください。 - Alibaba Cloud アカウント: デフォルトで権限を有しており、この操作を直接呼び出せます。
- RAM ユーザー: まず Alibaba Cloud Model Studio の API 権限 を取得し(この操作に必須な sfm:CreateIndex 権限を含む
-
呼び出しメソッド: 最新の Alibaba Cloud Model Studio SDK を使用してください。SDK は複雑な署名計算ロジックをカプセル化しており、呼び出しプロシージャを簡素化しています。
-
次のステップ: この操作はナレッジベース作成タスクの初期化のみを実行します。この操作を呼び出した後、作成を完了するには SubmitIndexJob 操作を呼び出す必要があります(そうしないと空のナレッジベースが作成されます)。コード例については、ナレッジベース API ガイド を参照してください。
-
べき等性: この操作にはべき等性がありません。繰り返し呼び出すと、同じ名前の複数のナレッジベースが作成される可能性があります。まず照会してから作成することで、べき等性のある呼び出しを実装してください。
レート制限: この操作にはレート制限が適用されます。毎秒 10 回を超える呼び出しを行わないでください。スロットリングされた場合は、後でリトライしてください。
今すぐお試しください
この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。
RAM 認証
下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。
-
アクション:特定のリソースに対して実行可能な操作。ポリシー構文では
Action要素として指定します。 -
API:アクションを具体的に実行するための API。
-
アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。
-
リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
Resource要素で対応する ARN を指定してください。 - リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーの
Resource要素でアスタリスク (*) でマークされます。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
-
条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
-
依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。
アクション | アクセスレベル | リソースタイプ | 条件キー | 依存アクション |
|---|---|---|---|---|
sfm:CreateIndex | create | *すべてのリソース。
| なし | なし |
リクエスト構文
POST /{WorkspaceId}/index/create HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| WorkspaceId | string | 必須 | ワークスペース ID。ナレッジベースを作成するワークスペースを指定します。詳細については、ワークスペースの使用方法 を参照してください。 | llm-3z7uw7fwz0vexxxx。 |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| Name | string | 必須 | ナレッジベース名。名前は 1~20 文字で、漢字、英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.)、コロン (:) を含めることができます。 | EnterpriseHelpDocLibrary. |
| StructureType | string | 必須 | ナレッジベースのタイプ。 有効な値:
ナレッジベースのタイプは作成後に変更できません。 列挙値:
| unstructured |
| EmbeddingModelName | string | 任意 |
デフォルト値: 空。text-embedding-v2 モデルが使用されます。 列挙値:
| text-embedding-v4 |
| RerankModelName | string | 任意 | ナレッジベースで使用される再ランキングモデル。再ランキングモデルは外部スコアリングシステムであり、ユーザークエリとナレッジベース内の各テキストチャンク間の類似度スコアを計算し、降順にソートして、スコアが最も高い上位 K 個のテキストチャンクを返します。有効な値:
デフォルト値: 空。gte-rerank-hybrid が使用されます。 意味的再ランキングのみが必要な場合は 列挙値:
| gte-rerank-hybrid。 |
| RerankMinScore | number | 任意 | 類似度のしきい値。この値を超える類似度スコアを持つテキストチャンクのみがリコールされます。このパラメーターは、再ランキングモデルによって返されるテキストチャンクをフィルタリングします。有効値: [0.01-1.00]。 指定しない場合、デフォルト値は 0.01 です。 | 0.20 |
| ChunkSize | integer | 任意 | チャンクサイズ。テキストチャンクあたりの最大文字数を指定します。この長さを超えた場合、テキストが切り捨てられる可能性があります。 有効値: [1-6000]。指定しない場合、デフォルト値は 500 です。
| 128 |
| OverlapSize | integer | 任意 | チャンクオーバーラップサイズ。現在のテキストチャンクと前のテキストチャンク間の重複文字数を指定します。有効値: [0-1024]。 指定しない場合、デフォルト値は 100 です。
| 16 |
| Separator | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | (?<=。) |
| SourceType | string | 任意 | このパラメーターは最新の SDK で必須です。指定しないと、SubmitIndexJob 操作の呼び出し時にエラー「Required parameter(data_sources) missing or invalid」が返されます。 データソースタイプ。有効な値:
このパラメーターが DATA_CENTER_CATEGORY に設定されている場合は、 空のナレッジベースを作成するには、ファイルを含まない空のカテゴリを使用します。このパラメーターを DATA_CENTER_CATEGORY に設定し、 列挙値:
| DATA_CENTER_FILE。 |
| DocumentIds | array | 任意 | ナレッジベース作成時にインポートするファイルのリスト。ここにファイル ID を指定します。インポートするファイル数は 10,000 以下にすることを推奨します。残りのファイルについては、SubmitIndexAddDocumentsJob 操作を呼び出してインポートを続行してください。 | |
string | 任意 | ファイル ID。AddFile 操作によって返される | file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx。 | |
| CategoryIds | array | 任意 | ナレッジベース作成時にインポートするカテゴリ ID のリスト。指定されたカテゴリ配下のすべてのファイルがインポートされます。インポートするファイル数は 500 以下にすることを推奨します。残りのファイルについては、SubmitIndexAddDocumentsJob 操作を呼び出してインポートを続行してください。 | |
string | 任意 | カテゴリ ID。AddCategory 操作によって返される | ca_hiu2383nfxxxx。 | |
| TableIds | array | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | |
string | 任意 | |||
| SinkType | string | 必須 | ナレッジベースのベクトルストレージタイプ。詳細については、ナレッジベース を参照してください。有効な値:
以前に Alibaba Cloud Model Studio で ADB ストレージを使用したことがない場合は、ナレッジベースの作成 ページに移動し、ベクトルストレージタイプとして ADB-PG を選択して、指示に従って権限付与を完了してください。ADB を渡す場合は、 列挙値:
| BUILT_IN。 |
| SinkInstanceId | string | 任意 | AnalyticDB for PostgreSQL インスタンス ID( | gp-bp32109xxxx。 |
| SinkRegion | string | 任意 | AnalyticDB for PostgreSQL インスタンスのリージョン( | cn-hangzhou。 |
| Columns | array<object> | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | |
object | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | ||
| Column | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | school。 |
| IsRecall | boolean | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | true。 |
| IsSearch | boolean | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | true。 |
| Name | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | School. |
| Type | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | string |
| Description | string | 任意 | ナレッジベースの説明。説明は最大 1000 文字まで指定できます。 デフォルト値: 空。 | 企業のヘルプドキュメントライブラリには、会社の方針や製品カタログなどの重要な資料が含まれています。 |
| metaExtractColumns | array<object> | 任意 | メタデータ抽出構成。メタデータは、非構造化データコンテンツに関連する追加属性のセットです。これらの属性はキーと値のペアとしてテキストチャンクに統合されます。詳細については、ナレッジベース を参照してください。 | |
object | 任意 | |||
| Key | string | 任意 | メタデータフィールド。フィールドは 1~50 文字で、英字とアンダースコアのみを含めることができます。このパラメーターを指定する場合は、 | author。 |
| Value | string | 任意 | メタデータフィールドの値。 | Tim。 |
| Type | string | 任意 | メタデータフィールドの抽出メソッド。有効な値:
列挙値:
| constant |
| Desc | string | 任意 | メタデータフィールドの中国語の説明。説明は最大 1000 文字で、漢字、英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.)、コロン (:) を含めることができます。デフォルト値: 空。 | AuthorName. |
| EnableLlm | boolean | 任意 | このメタデータフィールドとその値が、テキストチャンクのコンテンツとともに large 言語モデルの回答生成プロセスに参加するかどうかを指定します。有効な値:
デフォルト値: false。 列挙値:
| false。 |
| EnableSearch | boolean | 任意 | このメタデータフィールドとその値が、テキストチャンクのコンテンツとともにナレッジベースの取得に参加するかどうかを指定します。有効な値:
デフォルト値: false。 列挙値:
| false。 |
| enableHeaders | boolean | 任意 | すべての xlsx および xls ファイルの最初の行をヘッダーとして扱い、各テキストチャンクに連結するかどうかを指定します。これにより、large 言語モデルがヘッダーを通常のデータ行として扱うことを防ぎます。 インポートするすべてのファイルが .xlsx または .xls フォーマットで、ヘッダーを含んでいる場合にのみこの特徴を有効にしてください。それ以外の場合は有効にしないでください。 有効な値:
指定しない場合、この特徴はデフォルトで無効になっています。 列挙値:
| false。 |
| chunkMode | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 列挙値:
| regex。 |
| EnableRewrite | boolean | 任意 | マルチターン会話の書き換えを有効にするかどうかを指定します。有効な値:
指定しない場合、この特徴はデフォルトで有効になっています。 列挙値:
| true。 |
| CreateIndexType | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | standard。 |
| pipelineCommercialType | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | standard。 |
| pipelineCommercialCu | integer | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | 1 |
| pipelineRetrieveRateLimitStrategy | string | 任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | downgrade |
| knowledgeType | string | 任意 | データソースコード。データクエリナレッジベースを作成する際に必須です。table および database パラメーターと一緒に使用します。
| 260xxx。 |
| RerankMode | string | 任意 | データテーブル名。データクエリナレッジベースを作成する際に必須です。 データテーブルは、connectId または datasourceCode で指定されたデータソースに存在する必要があります。 列挙値:
| lance。 |
| RerankInstruct | string | 任意 | データベース名。データクエリナレッジベースを作成する際に必須です。 データベースは、datasourceCode で指定されたデータソースに存在する必要があります。 | database_a6eacabe6 |
任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | document | ||
任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | basic_document_qa | ||
任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 | conn_mysql_xxx_xxx。 | ||
任意 | connector | |||
任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 [_single.params.RerankMode.enum.similar: 相似模式。]similar: 類似度モード。 [_single.params.RerankMode.enum.custom: 自定义模式。]custom: カスタムモード。 [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (デフォルト)Q&A モード。 [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: 類似度モード。 [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: カスタムモード。 [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa: (デフォルト)Q&A モード。 [_single.params.RerankMode.enum.similar: 相似模式。]similar: 類似度モード。 [_single.params.RerankMode.enum.custom: 自定义模式。]custom: カスタムモード。 [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa: (デフォルト)Q&A モード。 [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: 類似度モード。 [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: カスタムモード。 [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa: (デフォルト)Q&A モード。 [_single.params.RerankMode.enum.similar: 相似模式。]similar: 類似度モード。 [_single.params.RerankMode.enum.custom: 自定义模式。]custom: カスタムモード。 [_single.params.RerankMode.enum.qa:(默认值) 问答模式。]qa:(デフォルト)Q&A モード。 [parameters.33.schema.enumValueTitles.similar: 相似模式。]similar: 相似模式。 [parameters.33.schema.enumValueTitles.custom: 自定义模式。]custom: 自定义模式。 [parameters.33.schema.enumValueTitles.qa:(默认值) 问答模式。]qa:(默认值) 问答模式。 列挙値:
| qa | ||
任意 | このパラメーターは利用できません。このパラメーターを渡さないでください。 |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | レスポンスのスキーマ。 | ||
| Code | string | エラー状態コード。 | |
| Data | object | リクエスト成功時に返されるビジネスデータ。 | |
| Id | string | ナレッジベース ID。 この値を適切に保存してください。このナレッジベースに関連する後続のすべての API 操作で必須になります。 | jkurxhxxxx。 |
| Message | string | エラーメッセージ。 | |
| RequestId | string | リクエスト ID。 | 17204B98-xxxx-4F9A--2446A84821CA。 |
| Status | string | 操作によって返される状態コード。 | "200" |
| Success | boolean | リクエストが成功したかどうかを示します。有効な値:
| true。 |
例
成功レスポンス
JSONJSON
{
"Code": "",
"Data": {
"Id": "jkurxhxxxx"
},
"Message": "",
"RequestId": "17204B98-xxxx-4F9A--2446A84821CA",
"Status": "\"200\"",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。