すべてのプロダクト
Search

このプロダクト

    :SubmitIndexAddDocumentsJob

    ドキュメントセンター

    :SubmitIndexAddDocumentsJob

    最終更新日:Aug 13, 2025

    解析済みのドキュメントを非構造化ナレッジベースに追加します。この API を使用して構造化ナレッジベースにナレッジを追加することはできません。このトピックの「使用方法」セクションを参照してください。

    操作の説明

    • 最初にドキュメントを [データ管理] にアップロードし、FileId を取得する必要があります。ドキュメントは、ナレッジベースのナレッジソースです。詳細については、「データのインポート」をご参照ください。
    • この操作を呼び出す前に、ナレッジベースが作成済みで、削除されていないことを確認してください。つまり、ナレッジベースのプライマリキー ID IndexId が有効であることを確認してください。
    • この操作を呼び出した後、 [GetIndexJobStatus] 操作を呼び出してジョブのステータスをクエリできます。1 分間に 20 回を超える GetIndexJobStatus 操作の呼び出しは、速度制限をトリガーする可能性があります。
    • この操作が呼び出されてから実行が完了するまでには時間がかかります。リクエストが返される前に新しいリクエストを作成しないでください。このインターフェイスは冪等ではありません。

    デバッグ

    このインターフェースは OpenAPI Explorer で直接実行できるため、署名の計算の手間が省けます。正常に実行されると、OpenAPI Explorer は SDK コードサンプルを自動的に生成できます。

    権限情報

    次の表は、API に対応する権限情報を示しています。Action ポリシー要素で権限情報を使用して、RAM ユーザーまたは RAM ロールにこの API 操作を呼び出す権限を付与できます。説明：

    • 操作：リソースに対する操作を指定するために Action 要素で使用できる値。
    • アクセスレベル：各操作のアクセスレベル。レベルは読み取り、書き込み、およびリストです。
    • リソースタイプ：RAM ユーザーまたは RAM ロールに操作の実行を承認できるリソースのタイプ。次の項目に注意してください：
      • 必須のリソースタイプの場合は、 * のプレフィックスで示します。
      • リソースレベルで権限を付与できない場合は、操作の「リソースタイプ」列に すべてのリソース が使用されます。
    • 条件キー：クラウドサービスによって定義される条件キー。
    • 関連操作：操作を完了するために RAM ユーザーまたは RAM ロールが実行する権限を持っている必要があるその他の操作。操作を完了するには、RAM ユーザーまたは RAM ロールが関連操作を実行する権限を持っている必要があります。
    操作アクセスレベルリソースタイプ条件キー関連操作
    sfm:SubmitIndexAddDocumentsJob作成
    *すべてのリソース
    *
      なし
    		なし

    リクエスト構文

    リクエストパラメーター

    パラメータータイプ必須説明例
    WorkspaceIdstringはい

    ナレッジベースが属するワークスペースの ID。ワークスペース ID を表示するには、コンソールの [ホームページ] の左上隅にある [ワークスペースの詳細] アイコンをクリックします。

    		ws_3Nt27MYcoK191ISp
    IndexIdstringはい

    ナレッジベースのプライマリキー ID。 [CreateIndex] 操作によって返される Data.Id パラメーターです。

    		79c0aly8zw
    SourceTypestringはい

    [データ管理] のデータ型。詳細については、「ナレッジベースの作成」をご参照ください。有効な値：

    • DATA_CENTER_CATEGORY：カテゴリタイプ。データセンターの 1 つ以上のカテゴリからすべてのドキュメントをインポートします。
    • DATA_CENTER_FILE：ドキュメントタイプ。データセンターから 1 つ以上のドキュメントをインポートします。
    注記 このパラメーターを DATA_CENTER_CATEGORY に設定する場合は、CategoryIds パラメーターを指定する必要があります。このパラメーターを DATA_CENTER_FILE に設定する場合は、DocumentIds パラメーターを指定する必要があります。
    		DATA_CENTER_FILE
    DocumentIdsarrayいいえ

    ドキュメントのプライマリキー ID のリスト。

    stringいいえ

    ドキュメントのプライマリキー ID。ID を表示するには、 [データ管理] ページでファイル名の横にある [ID] アイコンをクリックします。

    		doc_ea4a504d9ce545508d8aa6d90371bf5410021401
    CategoryIdsarrayいいえ

    カテゴリのプライマリキー ID のリスト。

    stringいいえ

    カテゴリのプライマリキー ID。カテゴリ ID を表示するには、 [データ管理] ページの [非構造化データ] タブでカテゴリ名の横にある [ID] アイコンをクリックします。

    		cate_21a407a3372c4ba7aedc649709143f0c10021401

    レスポンスパラメーター

    パラメータータイプ説明例
    object

    レスポンスのスキーマ

    RequestIdstring

    リクエスト ID。

    		778C0B3B-03C1-5FC1-A947-36EDD13606AB
    Dataobject

    返されるデータ。

    Idstring

    タスクのプライマリキー ID、JobId。

    		42687eb254a34802bed398357f5498ae
    Statusstring

    返される HTTP ステータスコード。

    		200
    Successboolean

    API 呼び出しが成功したかどうかを示します。有効な値：

    • true
    • false
    		true
    Messagestring

    エラーメッセージ。

    		必須パラメーター (%s) が見つからないか無効です。リクエストパラメーターを確認してください。
    Codestring

    HTTP ステータスコード

    		Index.InvalidParameter

    例

    成功レスポンスのサンプル

    JSON形式

    {
  "RequestId": "778C0B3B-03C1-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": 200,
  "Success": true,
  "Message": "必須パラメーター (%s) が見つからないか無効です。リクエストパラメーターを確認してください。",
  "Code": "Index.InvalidParameter"
}

    エラーコード

    HTTP ステータスコードエラーコードエラーメッセージ
    400IdempotentParameterMismatchリクエストは以前のリクエストと同じクライアントトークンを使用していますが、同一ではありません。リクエストが同一でない限り、異なるリクエストでクライアントトークンを再利用しないでください。

    エラーコードのリストについては、サービスエラーコード をご覧ください。

    変更履歴

    変更日時変更の概要操作
    変更履歴はありません