Vector Store-Dateien-API

Vektorspeicherdateien sind Dateien, die Sie an einen Vektorspeicher anhängen können.

Hinweis

Die OCI Vector Store Files APII verwendet dasselbe Format wie die OpenAI Vector Store Files API mit dem OCI OpenAI-kompatiblen Endpunkt. Syntax- und Anforderungsdetails finden Sie in der Dokumentation zur OpenAI Vector Store Files API.

Unterstützter API-Endpunkt

Basis-URL Endpunktpfad Authentifizierung
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /vector_stores/{id}/files API-Schlüssel oder IAM-Session

Ersetzen Sie ${region} durch eine unterstützte Region, wie us-chicago-1.

Obwohl das Anforderungsformat OpenAI-kompatibel ist, verwendet die Authentifizierung OCI-Zugangsdaten, Anforderungen werden über OCI Generative AI-Inferenzendpunkte weitergeleitet, und Ressourcen und Ausführung bleiben in OCI.

Tipp

Die Schritte, die vor der Verwendung dieser API ausgeführt werden müssen, finden Sie unter QuickStart.

Authentifizierung

Sie können auf zwei Arten auf OCI OpenAI-kompatible Endpunkte zugreifen:

Verwenden Sie API-Schlüssel für Tests und frühe Entwicklung. Verwenden Sie die IAM-basierte Authentifizierung für Produktions-Workloads und OCI-verwaltete Umgebungen.

Vektorspeicherdatei erstellen

POST /vector_stores/{vector_store_id}/files

Referenz

Vektorspeicherdatei erstellen

Beispiel:

# create vector store file

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

Vector Store-Dateien auflisten

GET /vector_stores/{vector_store_id}/files

Referenz

Vektorspeicherdateien auflisten

Beispiel:

# list vector store files

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

Informationen zu Vektorspeicherdateien werden abgerufen

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

Referenz

Vektorspeicherdatei abrufen

Beispiel:

# retrieve vector store file

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

Vektorspeicherdatei löschen

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

Referenz

Vektorspeicherdatei löschen

Beispiel:

# 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)