Documentation Oracle Cloud Infrastructure

API de fichiers

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

En joignant des fichiers à des flux de travail tels que l'extraction et la synthèse des tâches, les agents peuvent travailler avec des matériaux source volumineux ou complexes sans que vous ayez à 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 gardant la gestion des données centralisée et cohérente.

Avertissement

Ce service n'a pas pour objet le traitement de données à caractère personnel ni de données (par exemple, certaines informations réglementées sur la santé ou sur les cartes de paiement) qui imposent à Oracle des obligations spécifiques en matière de sécurité, de protection des données ou de réglementation s'ajoutant à celles indiquées dans votre contrat avec Oracle ou qui diffèrent de celles-ci.

Remarque

L'API OCI Files utilise le même format que l'API OpenAI Files avec l'adresse compatible OCI OpenAI. Pour plus d'informations sur la syntaxe et les demandes, reportez-vous à la documentation de l'API OpenAI Files.

Adresse d'API prise en charge

URL de base Chemin de l'adresse 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 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 de configuration avant d'utiliser cette API, reportez-vous à QuickStart.

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.

Chargement d'un fichier

POST /files

Paramètres du corps
  • file (obligatoire) : objet de fichier à télécharger
  • purpose (requis) : objet du fichier. Valeurs prises en charge :
    • assistants
    • batch
    • fine-tune
    • vision
    • user_data
    • evals
  • expires_after (facultatif) : stratégie d'expiration du fichier
Restrictions de type de fichier (par objectif)
  • 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)

Répertorier les fichiers

GET /files

Paramètres d'entrée
  • after (facultatif) : curseur à utiliser dans la pagination
  • limit (facultatif) : nombre d'objets à renvoyer
  • order (facultatif) : tri par created_at ("asc" ou "desc")
  • purpose (facultatif) : filtre les fichiers par fonction
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

Récupérer le contenu du fichier

Exemple Python :

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

Suppression d'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)