すべてのプロダクト
Search
ドキュメントセンター

Alibaba Cloud Model Studio:CreateIndex

最終更新日:Apr 16, 2026

この API を使用して、ドキュメント、オーディオ、ビデオ用の非構造化ナレッジベースと、データクエリまたは画像 Q&A 用の構造化ナレッジベースの 2 種類のナレッジベースを作成します。

操作説明

  • 権限
    • RAM ユーザー:RAM ユーザーは、この操作を呼び出す前に、Alibaba Cloud Model Studio の必要な API 権限を取得し、ワークスペースに参加する必要があります。この操作に必要な `sfm:CreateIndex` 権限を含む `AliyunBailianDataFullAccess` ポリシーを使用できます。

    • Alibaba Cloud アカウント:デフォルトでは、Alibaba Cloud アカウント (root ユーザー) は必要な権限を持っており、この操作を直接呼び出すことができます。

  • 呼び出し方法:この操作を呼び出すには、最新バージョンの Alibaba Cloud Model Studio SDK を使用します。SDK は複雑な署名計算ロジックを処理し、プロセスを簡素化します。

  • 次のステップ:この操作はナレッジベース作成ジョブを初期化するだけです。この操作を呼び出した後、SubmitIndexJob 操作を呼び出して作成を完了する必要があります。そうしないと、空のナレッジベースが作成されます。関連するコード例については、「ナレッジベース API ガイド」をご参照ください。

  • べき等性:この操作はべき等ではありません。繰り返し呼び出すと、同じ名前のナレッジベースが複数作成される可能性があります。べき等性を確保するには、ナレッジベースを作成する前にクエリを実行してください。

レート制限: この操作を頻繁に呼び出すと、レート制限の対象となります。1 秒あたり 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要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sfm:CreateIndex

create

*All Resource

*

なし なし

リクエスト構文

POST /{WorkspaceId}/index/create HTTP/1.1

パスパラメータ

パラメーター

必須 / 任意

説明

WorkspaceId

string

必須

ナレッジベースを作成するワークスペースの ID。ワークスペース ID の取得方法の詳細については、「ワークスペースの使用方法」をご参照ください。

llm-3z7uw7fwz0vexxxx

リクエストパラメーター

パラメーター

必須 / 任意

説明

Name

string

必須

ナレッジベースの名前。名前は 1~20 文字で、中国語文字、英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.)、コロン (:) を使用できます。

企业帮助文档库

StructureType

string

必須

ナレッジベースのタイプ。

有効な値

  • unstructured:ドキュメント検索、オーディオ、またはビデオ用のナレッジベース。ドキュメント検索のデフォルトシナリオは、基本的なドキュメント Q&A です。

説明

ナレッジベースのタイプは、作成後に変更することはできません。

列挙値:

  • unstructured :

    unstructured

unstructured

EmbeddingModelName

string

任意

  • ナレッジベースが使用するベクトルモデルです。ベクトルモデルは、元の入力プロンプトとナレッジテキストを数値ベクトルに変換して、その類似性を比較します。デフォルトの `text-embedding-v2` モデル (現在は変更不可) は、中国語と英語の両方、および他の複数の言語をサポートし、ベクトル結果を正規化します。詳細については、「ベクトル化」をご参照ください。有効な値:

  • text-embedding-v2

このパラメーターを指定しない場合、`text-embedding-v2` が使用されます。

列挙値:

  • text-embedding-v2 :
    text-embedding-v2

text-embedding-v2

RerankModelName

string

任意

ナレッジベースが使用する再ランキングモデル。再ランキングモデルは、ユーザーの質問とナレッジベース内の各テキストチャンクとの間の類似性スコアを計算し、降順にソートして、上位 K 個のテキストチャンクを返す外部スコアリングシステムです。有効な値:

  • gte-rerank-hybrid:公式再ランキング。

  • gte-rerank:gte-rerank 再ランキング。

このパラメーターを指定しない場合、`gte-rerank-hybrid` が使用されます。

説明

セマンティックソートのみが必要な場合は `gte-rerank` を使用してください。関連性を確保するためにセマンティックソートとテキストマッチング機能の両方が必要な場合は `gte-rerank-hybrid` を使用してください。

列挙値:

  • gte-rerank-hybrid :

    公式再ランキング

  • gte-rerank :

    gte-rerank 再ランキング

gte-rerank-hybrid

RerankMinScore

number

任意

類似性のしきい値。この値より大きい類似性スコアを持つテキストチャンクのみが取得されます。これは、再ランキングモデルによって返されるテキストチャンクをフィルターするために使用されます。値は 0.01 から 1.00 の間でなければなりません。

このパラメーターを指定しない場合、デフォルト値の 0.01 が使用されます。

0.20

ChunkSize

integer

任意

チャンクサイズ。各テキストチャンクの最大文字数です。この長さを超えると、テキストが切り捨てられる可能性があります。

値は 1 から 6000 の間でなければなりません。このパラメーターを指定しない場合、デフォルト値の 500 が使用されます。

説明

`ChunkSize` を 100 未満の値に設定する場合は、`OverlapSize` も設定する必要があります。両方のパラメーターを指定しないことも可能で、その場合はシステムがデフォルト値を使用します。

128

OverlapSize

integer

任意

重複サイズ。現在のテキストチャンクと前のテキストチャンクとの間の重複する文字数です。値は 0 から 1024 の間でなければなりません。

このパラメーターを指定しない場合、デフォルト値の 100 が使用されます。

説明

`OverlapSize` は `ChunkSize` より小さくする必要があります。そうしないと、チャンキングエラーが発生します。

16

Separator

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

(?<=。)

SourceType

string

任意

重要 最新の SDK バージョンでは、このパラメーターは必須です。そうしないと、SubmitIndexJob 操作を呼び出すと「Required parameter(data_sources) missing or invalid」というエラーが発生します。

インポートされたデータのソース。有効な値:

  • DATA_CENTER_CATEGORY:カテゴリタイプ。アプリケーションデータで指定されたカテゴリの下にあるすべてのファイルをインポートします。一度に複数のカテゴリをインポートできます。

  • DATA_CENTER_FILE:ファイルタイプ。アプリケーションデータから指定されたファイルをインポートします。一度に複数のファイルをインポートできます。

説明

このパラメーターを DATA_CENTER_CATEGORY に設定した場合は、`CategoryIds` パラメーターを指定する必要があります。このパラメーターを DATA_CENTER_FILE に設定した場合は、`DocumentIds` パラメーターを指定する必要があります。

説明

空のナレッジベースを作成するには、ファイルを含まない空のカテゴリを使用します。このパラメーターを DATA_CENTER_CATEGORY に設定し、`CategoryIds` に空のカテゴリの ID を指定します。

列挙値:

  • DATA_CENTER_CATEGORY :

    カテゴリタイプ

  • DATA_CENTER_FILE :

    ファイルタイプ

DATA_CENTER_FILE

DocumentIds

array

任意

ナレッジベースを作成する際にファイルをインポートできます。インポートするファイルのリストを ID で指定します。10,000 ファイル以下のインポートを推奨します。それ以上のファイルがある場合は、SubmitIndexAddDocumentsJob 操作を呼び出して後でインポートできます。

string

任意

ファイル ID。これは AddFile 操作によって返される `FileId` です。また、データコネクタの ファイルコネクタまたはアプリケーションデータの [ファイル] タブでファイル名の横にある ID アイコンをクリックして ID を取得することもできます。

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

CategoryIds

array

任意

ナレッジベースを作成する際にファイルをインポートできます。カテゴリ ID を指定して、対応するカテゴリの下にあるすべてのファイルをインポートします。10,000 ファイル以下のインポートを推奨します。それ以上のファイルがある場合は、SubmitIndexAddDocumentsJob 操作を呼び出して後でインポートできます。

string

任意

カテゴリ ID。これは AddCategory 操作によって返される `CategoryId` です。また、アプリケーションデータの [ファイル] タブでカテゴリ名の横にある ID アイコンをクリックして取得することもできます。

ca_hiu2383nfxxxx

TableIds

array

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

string

任意

SinkType

string

必須

ナレッジベースベクトルのストレージクラス。詳細については、「ナレッジベース」をご参照ください。有効な値:

  • BUILT_IN:Alibaba Cloud Model Studio プラットフォームでベクトルデータをホストします。

  • ADB:AnalyticDB for PostgreSQL。データベース管理、監査、モニタリングなどの高度な機能が必要な場合は、ADB を選択することをお勧めします。

説明

Alibaba Cloud Model Studio で ADB ストレージを使用したことがない場合は、ナレッジベースの作成ページに移動し、ベクトルストレージクラスを ADB-PG に設定し、画面の指示に従って必要な権限を付与してください。このパラメーターを ADB に設定した場合は、`SinkInstanceId` および `SinkRegion` パラメーターを指定する必要があります。

BUILT_IN

SinkInstanceId

string

任意

AnalyticDB for PostgreSQL インスタンスの ID。このパラメーターは、`SinkType` が ADB に設定されている場合にのみ必須です。AnalyticDB for PostgreSQL インスタンスリストページに移動して、この ID を取得します。

gp-bp32109xxxx

SinkRegion

string

任意

AnalyticDB for PostgreSQL インスタンスが配置されているリージョン。このパラメーターは、`SinkType` が ADB に設定されている場合にのみ必須です。 DescribeRegions 操作を呼び出して、リージョンのリストを取得できます。

cn-hangzhou

Columns

array<object>

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

object

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

Column

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

school

IsRecall

boolean

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

true

IsSearch

boolean

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

true

Name

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

学校

Type

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

string

Description

string

任意

ナレッジベースの説明。説明は 0~1,000 文字の英語または中国語文字で構成できます。 デフォルト値は空です。

企业帮助文档库包括了公司制度、产品清单等重要资料。

metaExtractColumns

array<object>

任意

メタデータ抽出構成。メタデータは、非構造化データコンテンツに関連する一連の追加属性です。これらの属性は、キーと値のペアとしてテキストチャンクに統合されます。詳細については、「ナレッジベース」をご参照ください。

object

任意

Key

string

任意

メタデータフィールド。フィールド名は 1~50 文字で、英字またはアンダースコアで構成する必要があります。このパラメーターを指定する場合は、`Value` および `Type` パラメーターも指定する必要があります。

author

Value

string

任意

メタデータフィールドの値。

Tim

Type

string

任意

メタデータフィールドの値を取得するメソッド。有効な値:

  • constant:定数。

  • variable:変数。

  • custom_prompt:大規模言語モデル (LLM)。

  • regular:正規表現。

  • keywords:キーワード検索。

列挙値:

  • constant :

    定数抽出

  • keywords :

    キーワード抽出

  • custom_prompt :

    大規模言語モデル

  • variable :

    変数抽出

  • regular :

    正規表現

constant

Desc

string

任意

メタデータフィールドの中国語の説明。説明は 0~1,000 文字で、中国語文字、英字、数字、アンダースコア (_)、ハイフン (-)、ピリオド (.)、コロン (:) を使用できます。デフォルト値は空です。

作者名

EnableLlm

boolean

任意

有効にすると、メタデータフィールドとその値が、LLM の回答生成プロセスでテキストチャンクコンテンツとともに使用されます。有効な値:

  • true:有効。

  • false:無効。

デフォルト値は false です。

列挙値:

  • true :

    有効

  • false :

    無効

false

EnableSearch

boolean

任意

有効にすると、メタデータフィールドとその値が、ナレッジベースの取得プロセスでテキストチャンクコンテンツとともに使用されます。有効な値:

  • true:有効。

  • false:無効。

デフォルト値は false です。

列挙値:

  • true :

    有効

  • false :

    無効

false

enableHeaders

boolean

任意

すべての .xlsx および .xls ファイルの最初の行をテーブルヘッダーとして扱い、各テキストチャンクに追加するかどうかを指定します。これにより、LLM がヘッダーを通常のデータ行として扱うのを防ぎます。

説明

この機能は、インポートされたすべてのファイルが .xlsx または .xls 形式でヘッダーを含んでいる場合にのみ有効にすることをお勧めします。そうでない場合は、有効にしないでください。

有効な値:

  • true:有効。

  • false:無効。

このパラメーターを指定しない場合、この機能はデフォルトで無効になります。

列挙値:

  • true :

    有効

  • false :

    無効

false

chunkMode

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

列挙値:

  • regex :

    正規表現でチャンク

  • length :

    長さでチャンク

  • h1 :

    レベル 1 の見出しでチャンク

  • h2 :

    レベル 2 の見出しでチャンク

  • page :

    ページでチャンク

regex

EnableRewrite

boolean

任意

マルチターン対話の書き換えを有効にするかどうかを指定します。有効な値:

  • true:有効。

  • false:無効。

このパラメーターを指定しない場合、この機能はデフォルトで有効になります。

列挙値:

  • true :

    有効

  • false :

    無効

true

CreateIndexType

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

standard

pipelineCommercialType

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

standard

pipelineCommercialCu

integer

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

1

pipelineRetrieveRateLimitStrategy

string

任意

説明

このパラメーターはまだ利用できません。指定しないでください。

downgrade

knowledgeType

string

任意

データソースコード。このパラメーターは、データクエリナレッジベースを作成する際に必須であり、`table` および `database` とともに使用されます。

説明
  • この操作はカスタムデータベースの関連付けをサポートしていません。Alibaba Cloud Model Studio コンソールを使用して作成してください。

document

RerankMode

string

任意

データテーブルの名前。このパラメーターは、データクエリのナレッジベースを作成する際に必須です。

データテーブルは、`connectId` または `datasourceCode` で指定されたデータソースに存在する必要があります。

列挙値:

  • similar: 相似模式。 :
    similar: 類似モード。
  • custom: 自定义模式。 :
    custom: カスタムモード。
  • qa:(默认值) 问答模式。 :
    qa: (デフォルト) Q&A モード。

qa

RerankInstruct

string

任意

データベースの名前。データクエリナレッジベースを作成する場合、このパラメーターは必須です。

データベースは、`datasourceCode` で指定されたデータソース内に存在する必要があります。

レスポンスフィールド

フィールド

説明

object

レスポンスのスキーマ

Code

string

エラーステータスコード

Index.Forbidden

Data

object

リクエストが成功した場合に返されるビジネスデータ。

Id

string

ナレッジベースの ID。`IndexId` とも呼ばれます。これは、作成されたナレッジベースの一意の識別子です。

説明

この値は安全に保管してください。このナレッジベースに関連する後続のすべての API 操作で使用されます。

jkurxhxxxx

Message

string

エラーメッセージ

Invalid input, variable name is missing

RequestId

string

リクエスト ID

17204B98-xxxx-4F9A--2446A84821CA

Status

string

インターフェイスによって返されるステータスコード。

"200"

Success

boolean

リクエストが成功したかどうかを示します。指定可能な値:

  • true:成功

  • false:失敗

true

成功レスポンス

JSONJSON

{
  "Code": "Index.Forbidden",
  "Data": {
    "Id": "jkurxhxxxx"
  },
  "Message": "Invalid input, variable name is missing",
  "RequestId": "17204B98-xxxx-4F9A--2446A84821CA",
  "Status": "\"200\"",
  "Success": true
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。