Vector Store Files - List Vector Store Files

リファレンス

サービス:: AI Foundry

API バージョン:: v1

ベクターストアファイルの一覧を返します。

GET {endpoint}/vector_stores/{vectorStoreId}/files?api-version=v1

省略可能なパラメーターを含む:

GET {endpoint}/vector_stores/{vectorStoreId}/files?filter={filter}&api-version=v1&limit={limit}&order={order}&after={after}&before={before}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	次の形式のプロジェクトエンドポイント: https://.services.ai.azure.com/api/projects/
vectorStoreId	path	True	string	ベクトルストアの識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
after	query		string	改ページ位置付けに使用するカーソル。 after は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの次のページをフェッチするために after=obj_foo を含めることができます。
before	query		string	改ページ位置付けに使用するカーソル。は、リスト内の場所を定義するオブジェクト ID です。たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。
filter	query		VectorStoreFileStatusFilter	ファイルの状態でフィルター処理します。
limit	query		integer (int32)	返されるオブジェクトの数の制限。制限の範囲は 1 から 100 で、既定値は 20 です。
order	query		ListSortOrder	オブジェクトのcreated_atタイムスタンプによる並べ替え順序。昇順の場合は asc、降順の場合は desc。

応答

名前	型	説明
200 OK		要求は成功しました。
Other Status Codes	AgentV1Error	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://ai.azure.com/.default

例

VectorStoreFiles_ListVectorStoreFiles_MaximumSet

VectorStoreFiles_ListVectorStoreFiles_MinimumSet

VectorStoreFiles_ListVectorStoreFiles_MaximumSet

要求のサンプル

HTTP

GET {endpoint}/vector_stores/pxdgb/files?filter=in_progress&api-version=v1&limit=4&order=asc&after=skpeflglzjqbdnnxkfwzzfnwstfzng&before=xvqowfdzmyyyaerkecvd

応答のサンプル

状態コード:: 200

{
  "data": [
    {
      "id": "yqeohdhcu",
      "object": "vector_store.file",
      "usage_bytes": 12,
      "created_at": 29,
      "vector_store_id": "ppsgzjawikryevzvdusrtgxttrrmbl",
      "status": "in_progress",
      "last_error": {
        "code": "server_error",
        "message": "occbex"
      },
      "chunking_strategy": {
        "type": "VectorStoreChunkingStrategyResponse"
      }
    }
  ],
  "last_id": "xgjovhnxkkdxpudglbqx",
  "has_more": true
}

VectorStoreFiles_ListVectorStoreFiles_MinimumSet

要求のサンプル

HTTP

GET {endpoint}/vector_stores/nrmazftjcponrcnqfsz/files?api-version=v1

応答のサンプル

状態コード:: 200

{
  "data": [
    {
      "id": "yqeohdhcu",
      "object": "vector_store.file",
      "usage_bytes": 12,
      "created_at": 29,
      "vector_store_id": "ppsgzjawikryevzvdusrtgxttrrmbl",
      "status": "in_progress",
      "last_error": {
        "code": "server_error",
        "message": "occbex"
      },
      "chunking_strategy": {
        "type": "VectorStoreChunkingStrategyResponse"
      }
    }
  ],
  "has_more": true
}

定義

名前	説明
AgentErrorDetail	エージェント API によって返されるエラー情報について説明します。
AgentV1Error	エージェント API によって返されたエラーペイロード。
ListSortOrder	応答オブジェクトのリストを要求するときに使用可能な並べ替えオプション。
VectorStoreFileStatusFilter	ベクトルストアファイル取得エンドポイントのクエリパラメーターフィルター

AgentErrorDetail

Object

エージェント API によって返されるエラー情報について説明します。

名前	型	説明
code	string	機械可読のエラーコード。
message	string	エラーの人間が判読できる説明。
param	string	エラーの原因となったパラメータの名前 (該当する場合)。
type	string	エラータイプ識別子(例: `invalid_request_error`)。

AgentV1Error

Object

エージェント API によって返されたエラーペイロード。

名前	型	説明
error	AgentErrorDetail	エラーを表します。

ListSortOrder

列挙

応答オブジェクトのリストを要求するときに使用可能な並べ替えオプション。

値	説明
asc	昇順のソート順を指定します。
desc	降順のソート順を指定します。

VectorStoreFileStatusFilter

列挙

ベクトルストアファイル取得エンドポイントのクエリパラメーターフィルター

値	説明
cancelled	キャンセルされたファイルのみを取得する
completed	正常に処理されたファイルのみを取得する
failed	処理に失敗したファイルのみを取得する
in_progress	現在処理中のファイルのみを取得する

次の方法で共有

Vector Store Files - List Vector Store Files

URI パラメーター

応答

セキュリティ

OAuth2Auth

スコープ

例

VectorStoreFiles_ListVectorStoreFiles_MaximumSet

要求のサンプル

応答のサンプル

VectorStoreFiles_ListVectorStoreFiles_MinimumSet

要求のサンプル

応答のサンプル

定義

AgentErrorDetail

AgentV1Error

ListSortOrder

VectorStoreFileStatusFilter