Oracle Cloud Infrastructureドキュメント

ベクトル・ストア・ファイルAPI

ベクトル・ストア・ファイルは、ベクトル・ストアにアタッチできるファイルです。

ノート

OCI Vector Store Files APIIでは、OCI OpenAI互換エンドポイントを含むOpenAI Vector Store Files APIと同じ形式が使用されます。構文およびリクエストの詳細は、OpenAI Vector Store Files APIのドキュメントを参照してください。

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

ベースURL エンドポイント・パス 認証
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /vector_stores/{id}/files 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}/files

参照

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

例:

# create vector store file

vector_store_file = client.vector_stores.files.create(
  vector_store_id="xxx",
  file_id="xxx"
)
print(vector_store_file)

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

GET /vector_stores/{vector_store_id}/files

参照

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

例:

# list vector store files

vector_store_files = client.vector_stores.files.list(
  vector_store_id="xxx"
)
print(vector_store_files)

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

GET /vector_stores/{vector_store_id}/files/{file_id}

参照

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

例:

# retrieve vector store file

vector_store_file = client.vector_stores.files.retrieve(
  vector_store_id="xxx",
  file_id="xxx"
)
print(vector_store_file)

ベクトル・ストア・ファイルの削除

DELETE /vector_stores/{vector_store_id}/files/{file_id}

参照

ベクトル・ストア・ファイルの削除

例:

# delete a vector store file

deleted_vector_store_file = client.vector_stores.files.delete(
    vector_store_id="xxx",
    file_id="xxx"
)
print(deleted_vector_store_file)