Documentation sur Oracle Cloud Infrastructure

API Fichiers

Vous pouvez utiliser l'API Fichiers pour charger et gérer des documents et d'autres données que les agents peuvent utiliser lors de leur exécution.

En joignant des fichiers à des flux de travail tels que des tâches d'extraction et de récapitulation, les agents peuvent travailler avec des documents sources volumineux ou complexes sans avoir à coller du contenu dans des invites. Cette approche vous aide à créer des agents plus compétents qui peuvent utiliser les bases de connaissances, les rapports, les journaux et les jeux de données de manière évolutive et réutilisable, tout en assurant une gestion centralisée et cohérente des données.

Avertissement

Ce service ne vise pas à traiter des renseignements personnels ou des données (par exemple, certains renseignements réglementés sur la santé ou les cartes de paiement) qui imposent à Oracle des obligations particulières en matière de sécurité des données, de protection des données ou de réglementation, en plus de celles précisées dans votre entente avec Oracle.

Note

L'API des fichiers OCI utilise le même format que l'API des fichiers OpenAI avec le point d'extrémité compatible OCI OpenAI. Pour plus de détails sur la syntaxe et les demandes, consultez la documentation relative à l'API OpenAI Files.

Point d'extrémité d'API pris en charge

URL de base Chemin du point d'extrémité Authentification
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /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 la demande soit compatible avec OpenAI, l'authentification utilise les données d'identification OCI, les demandes sont acheminées au moyen des points d'extrémité d'inférence du service d'intelligence artificielle générative pour OCI et les ressources et l'exécution restent dans OCI.

Conseil

Pour les étapes de configuration avant d'utiliser cette API, voir QuickStart.

Chargement d'un fichier

POST /files

Paramètres du corps
  • file (obligatoire) : Objet de fichier à charger
  • purpose (obligatoire) : Objectif du fichier. Valeurs prises en charge :
    • assistants
    • batch
    • fine-tune
    • vision
    • user_data
    • evals
  • expires_after (facultatif) : Politique d'expiration pour le fichier
Restrictions de type de fichier (par usage)
  • batch: .jsonl
  • fine-tune: .jsonl
  • evals: .jsonl
  • vision: .gif, .jpeg, .jpg, .png, .webp
Référence

Charger le fichier

Exemple Python :

# upload a file

file_path = "./example-file.pdf"
with open(file_path, "rb") as f:
    file = client.files.create(
        file=f,
        purpose="user_data"
    )
print(file.id)

Liste des fichiers

GET /files

Paramètres d'entrée
  • after (facultatif) : Curseur à utiliser dans la pagination
  • limit (facultatif) : Nombre d'objets à retourner
  • order (facultatif) : Ordre de tri par created_at ("asc" ou "desc")
  • purpose (facultatif) : Filtrer les fichiers par objectif
Référence

Lister les fichiers

Exemple Python :

# list files

client = OpenAI(
    base_url="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1",
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    project="ocid1.generativeaiproject.oc1.us-chicago-1.xxxxxxxx",
)
files_list = client.files.list(order="asc")
print(files_list)

Extraction des informations sur le fichier

GET /files/{file_id}

Paramètre d'entrée
  • file_id (obligatoire) : ID du fichier à extraire
Référence

Extraire le fichier

Exemple Python :

# retrieve file
file = client.files.retrieve(file_id="xxx")
print(file)

Extraction du contenu du fichier

GET /files/{file_id}/content

Paramètre d'entrée
  • file_id (obligatoire) : ID du fichier dont vous voulez extraire le contenu
Référence

Extraire le contenu du fichier

Exemple Python :

# retrieve file content
file = client.files.content(file_id="xxx")
print(file.content)

Supprimer un fichier

DELETE /files/{file_id}

Paramètre d'entrée
  • file_id (obligatoire) : ID du fichier à supprimer
Référence

Supprimer le fichier

Exemple Python :

# delete file
delete_result = client.files.delete(file_id="xxx")
print(delete_result)