API File

È possibile utilizzare l'API File per caricare e gestire in modo sicuro documenti e altri dati che gli agenti possono utilizzare durante l'esecuzione.

Allegando file a flussi di lavoro come il recupero e il riepilogo delle attività, gli agenti possono lavorare con materiali di origine grandi o complessi senza dover incollare il contenuto nei prompt. Ciò consente di creare agenti più capaci in grado di utilizzare knowledge base, report, log e set di dati in modo scalabile e riutilizzabile, mantenendo al contempo la gestione dei dati centralizzata e coerente.

Avvertenza

Questo servizio non ha lo scopo di elaborare informazioni personali o dati (ad esempio, informazioni regolamentate in materia di salute o carte di pagamento) che impongono a Oracle specifici obblighi normativi, di sicurezza o protezione dei dati aggiuntivi o diversi da quelli specificati nell'accordo stipulato tra l'utente e Oracle.

Importante

L'API Files utilizza lo stesso formato dell'API Files OpenAI. Vedere OpenAI Files API documentation.

Caricamento di un File

POST/files

Parametri corpo
  • file (obbligatorio): oggetto file da caricare
  • purpose (obbligatorio): lo scopo del file. Valori supportati:
    • assistants
    • batch
    • fine-tune
    • vision
    • user_data
    • evals
  • expires_after (facoltativo): criterio di scadenza del file
Limitazioni del tipo di file (per scopo)
  • batch: .jsonl
  • fine-tune: .jsonl
  • evals: .jsonl
  • vision: .gif, .jpeg, .jpg, .png, .webp

Esempio:

# upload files

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

Lista dei file

GET/files

Parametri di input
  • after (facoltativo): Cursore da utilizzare nell'impaginazione
  • limit (facoltativo): numero di oggetti da restituire
  • order (facoltativo): ordina per created_at ("asc" o "desc")
  • purpose (facoltativo): Filtra i file per scopo

Esempio:

# list files
files_list = client.files.list(order="asc")
print(files_list)

Recupero delle informazioni sul file

GET/files/{file_id}

Parametri di input
  • file_id (obbligatorio): ID del file da recuperare

Esempio:

# retrieve file
file = client.files.retrieve(file_id="file-fra-d5dd80c5-da8c-435e-b336-48ce9b346200")
print(file)

Recupero del contenuto del file

GET/files/{file_id}/content

Parametri di input
  • file_id (obbligatorio): ID del file di cui si desidera recuperare il contenuto

Esempio:

# retrieve file content
file = client.files.content(file_id="file-fra-d5dd80c5-da8c-435e-b336-48ce9b346200")
print(file.content)

Eliminazione di un file

DELETE/files/{file_id}

Parametri di input
  • file_id (obbligatorio): ID del file da eliminare

Esempio:

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