Documentazione dell'infrastruttura Oracle Cloud

API File

È possibile utilizzare l'API File per caricare e gestire 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 in prompt. Questo approccio 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.

Nota

L'API File OCI utilizza lo stesso formato dell'API File OpenAI con l'endpoint compatibile con OCI OpenAI. Per i dettagli di sintassi e richiesta, consulta la documentazione API OpenAI Files.

Endpoint API supportato

URL di base Percorso endpoint Autenticazione
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /files Chiave API o sessione IAM

Sostituire ${region} con un'area OCI supportata come us-chicago-1.

Sebbene il formato della richiesta sia compatibile con OpenAI, l'autenticazione utilizza le credenziali OCI, le richieste vengono instradate tramite gli endpoint di inferenza OCI Generative AI e le risorse e l'esecuzione rimangono in OCI.

Suggerimento

Per i passi di impostazione prima di utilizzare questa interfaccia API, vedere Avvio rapido.

Autenticazione

È possibile accedere agli endpoint compatibili con OCI OpenAI in due modi:

Utilizza le API key per test e sviluppo precoce. Utilizza l'autenticazione basata su IAM per i carichi di lavoro di produzione e gli ambienti gestiti da OCI.

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
Di riferimento

Carica un file

Esempio di 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)

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
Di riferimento

Elenca i file

Esempio di 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)

Recupero delle informazioni sul file

GET /files/{file_id}

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

Recupera file

Esempio di Python:

# retrieve file
file = client.files.retrieve(file_id="xxx")
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
Di riferimento

Recupera contenuto file

Esempio di Python:

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

Eliminazione di un file

DELETE /files/{file_id}

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

Elimina file

Esempio di Python:

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