ListSearchLib API で検索ライブラリ管理 - Intelligent Media Services (IMS)

検索ライブラリのリストを取得します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNo	integer	任意	現在のページ番号。デフォルト値は 1 です。	1
PageSize	integer	任意	各ページに返すエントリ数。デフォルト値は 10 です。最大値は 50 です。	10

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	****3B-0E1A-586A-AC29-742247****
Success	string	リクエストが成功したかどうかを示します。	true
Code	string	リターンコード。	200
SearchLibInfoList	array<object>	検索ライブラリに関する情報のリスト。
	array<object>	検索ライブラリに関する情報。
SearchLibName	string	検索ライブラリ。	faceSearchLib
Status	string	ステータス。有効な値： normal：正常 deleting：ライブラリは削除中です。 deleteFail：ライブラリの削除に失敗しました。列挙値: normal : 正常 deleting : 削除中 deleteFail : 削除失敗	normal
IndexInfo	array<object>	インデックス情報。
	object
IndexType	string	インデックスタイプ。有効な値： mm：大規模言語モデル (LLM)。 face：顔。 aiLabel：DataQ - スマートタグサービス。	face
IndexStatus	string	インデックスステータス。デフォルト値は Active です。有効な値： Active：インデックスはアクティブです。 Deactive：インデックスは非アクティブです。	Active
IndexReadiness	string	インデックスの準備状況。有効な値： Initializing：インデックスは初期化中です。 Normal：インデックスは準備完了です。 Fail：インデックスの作成に失敗しました。	Normal
SearchLibConfig	string	検索ライブラリの設定。	{"faceGroupIds":"xxx1,xxx2,xx3"}
Total	integer	エントリの総数。	8

例

成功レスポンス

JSONJSON

{
  "RequestId": "******3B-0E1A-586A-AC29-742247******",
  "Success": "true",
  "Code": "200",
  "SearchLibInfoList": [
    {
      "SearchLibName": "faceSearchLib",
      "Status": "normal",
      "IndexInfo": [
        {
          "IndexType": "face",
          "IndexStatus": "Active",
          "IndexReadiness": "Normal"
        }
      ],
      "SearchLibConfig": "{\"faceGroupIds\":\"xxx1,xxx2,xx3\"}"
    }
  ],
  "Total": 8
}

エラーコード

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

変更履歴

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