Oracle Cloud Infrastructureドキュメント

ベクトル・ストア・ファイル・バッチAPI

ベクトル・ストア・ファイル・バッチは、多数のファイルを同時に管理するためのものです。

ノート

OCI Vector Storeファイル・バッチ・バッチAPIでは、OCI OpenAI互換エンドポイントを使用するOpenAI Vector Storeファイル・バッチ・バッチAPIと同じ形式が使用されます。構文およびリクエストの詳細は、OpenAI Vector Store File Batch Batches APIのドキュメントを参照してください。

サポートされているAPIエンドポイント

ベースURL エンドポイント・パス 認証
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /vector_stores/{id}/file_batches APIキーまたはIAMセッション

${region}を、us-chicago-1などのサポートされているOCIリージョンに置き換えます。

リクエスト形式はOpenAIと互換性がありますが、認証ではOCI資格証明が使用され、リクエストはOCI生成AI推論エンドポイントを介してルーティングされ、リソースと実行はOCIに残ります。

ヒント

このAPIを使用する前に実行するステップは、QuickStartを参照してください。

認証

OCI OpenAI互換エンドポイントには、次の2つの方法でアクセスできます。

テストおよび早期開発にAPIキーを使用します。本番ワークロードおよびOCI管理環境には、IAMベースの認証を使用します。

ベクトル・ストア・ファイル・バッチの作成

POST /vector_stores/{vector_store_id}/file_batches

参照

ベクトル・ストア・ファイル・バッチの作成

例:

# create vector store file batch

vector_store_file_batch = client.vector_stores.file_batches.create(
  vector_store_id="xxx",
  files=[
    ...
)
print(vector_store_file_batch)

ベクトル・ストア・ファイル・バッチのリスト

GET /vector_stores/{vector_store_id}/file_batches

参照

ベクトル・ストア・ファイル・バッチのリスト

例:

# list vector store file batches

vector_store_files = client.vector_stores.file_batches.list_files(
    vector_store_id="xxx"
    batch_id="xxx"
)
print(vector_store_files)

ベクトル・ストア・ファイル・バッチ情報の取得

GET /vector_stores/{vector_store_id}/file_batches/{batch_id}

参照

ベクトル・ストア・ファイル・バッチの取得

例:

# retrieve vector store file batch

vector_store_file_batch = client.vector_stores.file_batches.retrieve(
  vector_store_id="xxx",
  batch_id="xxx"
)
print(vector_store_file_batch)

ベクトル・ストア・ファイル・バッチの取消し

POST /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

参照

ベクトル・ストア・ファイル・バッチの取消

例:

# cancle a vector store file batch

canceled_vector_store_file_batch = client.vector_stores.file_batches.cancel(
    vector_store_id="xxx",
    file_id="xxx"
)
print(canceled_vector_store_file_batch)