API de fichiers de banque de vecteurs

Les fichiers de banque de vecteurs sont des fichiers que vous pouvez joindre à une banque de vecteurs.

Remarque

L'API OCI Vector Store Files APII utilise le même format que l'API OpenAI Vector Store Files avec l'adresse compatible OCI OpenAI. Pour plus de détails sur la syntaxe et les demandes, reportez-vous à la documentation de l'API des fichiers de banque de vecteurs OpenAI.

Adresse d'API prise en charge

URL de base Chemin de l'adresse Authentification
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /vector_stores/{id}/files Clé d'API ou session IAM

Remplacez ${region} par une région OCI prise en charge telle que us-chicago-1.

Bien que le format de demande soit compatible avec OpenAI, l'authentification utilise les informations d'identification OCI, les demandes sont acheminées via les adresses d'inférence OCI Generative AI et les ressources et l'exécution restent dans OCI.

Conseil

Pour connaître les étapes à effectuer avant d'utiliser cette API, reportez-vous à Démarrage rapide.

Authentification

Vous pouvez accéder aux adresses compatibles avec OCI OpenAI de deux manières :

Utiliser des clés d'API pour les tests et le développement anticipé. Utilisez l'authentification basée sur IAM pour les workloads de production et les environnements gérés par OCI.

Création d'un fichier de banque de vecteurs

POST /vector_stores/{vector_store_id}/files

Référence

Créer un fichier de banque de vecteurs

Par exemple :

# create vector store file

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

Liste des fichiers de banque de vecteurs

GET /vector_stores/{vector_store_id}/files

Référence

Répertorier les fichiers de stockage vectoriel

Par exemple :

# list vector store files

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

Extraction des informations du fichier de banque de vecteurs

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

Référence

Récupérer le fichier de stockage vectoriel

Par exemple :

# retrieve vector store file

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

Suppression d'un fichier de banque de vecteurs

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

Référence

Supprimer le fichier de stockage vectoriel

Par exemple :

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