Files - Upload

  • Riferimento
Servizio:
Azure AI Services
Versione API:
2024-10-21

Crea una nuova entità file caricando i dati da un computer locale. I file caricati possono, ad esempio, essere usati per il training o la valutazione di modelli ottimizzati.

POST {endpoint}/openai/files?api-version=2024-10-21

Parametri dell'URI

Nome In Necessario Tipo Descrizione
file
 formData True

file

Ottiene o imposta il file da caricare in Azure OpenAI.
purpose
 formData True

Purpose

Scopo previsto dei documenti caricati. Usare "ottimizzazione" per ottimizzare l'ottimizzazione. In questo modo è possibile convalidare il formato del file caricato.
endpoint
 path True

string

url

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://aoairesource.openai.azure.com. Sostituire "aoairesource" con il nome dell'account Azure OpenAI.
api-version
 query True

string

Versione dell'API richiesta.

Intestazione della richiesta

Media Types: "multipart/form-data"

Nome Necessario Tipo Descrizione
api-key True

string

Specificare qui la chiave dell'account OpenAI di Servizi cognitivi di Azure.

Risposte

Nome Tipo Descrizione
201 Created

File

Il file è stato creato correttamente.

Intestazioni

Location: string
Other Status Codes

ErrorResponse

Si è verificato un errore.

Sicurezza

api-key

Specificare qui la chiave dell'account OpenAI di Servizi cognitivi di Azure.

Tipo: apiKey
In: header

Esempio

Upload a file.

Esempio di richiesta

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-10-21

Risposta di esempio

Codice di stato:
201 
location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
  "status": "pending",
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "created_at": 1646126127,
  "object": "file"
}

Definizioni

Nome Descrizione
Error

Errore
ErrorCode

ErrorCode
ErrorResponse

ErrorResponse
File

File
FileState

FileState
InnerError

InnerError
InnerErrorCode

InnerErrorCode
Purpose

Scopo
TypeDiscriminator

TypeDiscriminator

Error

Errore

Nome Tipo Descrizione
code

ErrorCode

ErrorCode
Codici di errore definiti nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details

Error[]

Dettagli dell'errore, se disponibile.
innererror

InnerError

InnerError
Errore interno come definito nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message

string

Messaggio di questo errore.
target

string

Posizione in cui si è verificato l'errore, se disponibile.

ErrorCode

ErrorCode

Nome Tipo Descrizione
conflict

string

L'operazione richiesta è in conflitto con lo stato della risorsa corrente.
contentFilter

string

La generazione di immagini non è riuscita a causa del nostro sistema di sicurezza.
fileImportFailed

string

Importazione del file non riuscita.
forbidden

string

L'operazione non è consentita per la chiave utente/API corrente.
internalFailure

string

Errore interno. Riprovare.
invalidPayload

string

I dati della richiesta non sono validi per questa operazione.
itemDoesAlreadyExist

string

L'elemento esiste già.
jsonlValidationFailed

string

La convalida dei dati jsonl non è riuscita.
notFound

string

La risorsa non viene trovata.
quotaExceeded

string

Quota superata.
serviceUnavailable

string

Il servizio non è attualmente disponibile.
tooManyRequests

string

Troppe richieste. Riprovare più tardi.
unauthorized

string

La chiave utente/API corrente non è autorizzata per l'operazione.
unexpectedEntityState

string

L'operazione non può essere eseguita nello stato della risorsa corrente.

ErrorResponse

ErrorResponse

Nome Tipo Descrizione
error

Error

Errore
Contenuto degli errori come definito nelle linee guida microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

File

Nome Tipo Descrizione
bytes

integer

Dimensione del file quando disponibile (può essere null). Le dimensioni dei file superiori a 2^53-1 non sono supportate per garantire la compatibilità con i numeri interi JavaScript.
created_at

integer

Timestamp quando questo processo o elemento è stato creato (in periodi UNIX).
filename

string

Nome del file.
id

string

Identità dell'elemento.
object

TypeDiscriminator

TypeDiscriminator
Definisce il tipo di un oggetto .
purpose

Purpose

Scopo
Scopo previsto dei documenti caricati. Usare "ottimizzazione" per ottimizzare l'ottimizzazione. In questo modo è possibile convalidare il formato del file caricato.
status

FileState

FileState
Stato di un file.
status_details

string

Messaggio di errore con i dettagli nel caso in cui l'elaborazione del file non sia riuscita.

FileState

FileState

Nome Tipo Descrizione
deleted

string

L'entità è stata eliminata, ma può comunque essere fatto riferimento da altre entità che precedono l'eliminazione. Può essere categorizzato come stato terminale.
deleting

string

L'entità è ni il processo da eliminare. Questo stato non viene restituito da Azure OpenAI ed esposto solo per la compatibilità. Può essere categorizzato come stato attivo.
error

string

L'operazione ha completato l'elaborazione con un errore e non può essere ulteriormente utilizzata. Può essere categorizzato come stato terminale.
pending

string

L'operazione è stata creata e non è in coda da elaborare in futuro. Può essere categorizzato come stato inattivo.
processed

string

L'operazione è stata elaborata correttamente ed è pronta per l'utilizzo. Può essere categorizzato come stato terminale.
running

string

L'operazione è stata avviata per l'elaborazione. Può essere categorizzato come stato attivo.
uploaded

string

Il file è stato caricato ma non è ancora stato elaborato. Questo stato non viene restituito da Azure OpenAI ed esposto solo per la compatibilità. Può essere categorizzato come stato inattivo.

InnerError

InnerError

Nome Tipo Descrizione
code

InnerErrorCode

InnerErrorCode
Codici di errore interni definiti nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror

InnerError

InnerError
Errore interno come definito nelle linee guida di Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Nome Tipo Descrizione
invalidPayload

string

I dati della richiesta non sono validi per questa operazione.

Purpose

Scopo

Nome Tipo Descrizione
assistants

string

Questo file contiene i dati da usare negli assistenti.
assistants_output

string

Questo file contiene i risultati di un assistente.
batch

string

Questo file contiene i dati di input per un batch.
batch_output

string

Questo file contiene i risultati di un batch.
fine-tune

string

Questo file contiene i dati di training per un processo di ottimizzazione.
fine-tune-results

string

Questo file contiene i risultati di un processo di ottimizzazione.

TypeDiscriminator

TypeDiscriminator

Nome Tipo Descrizione
batch

string

Questo oggetto rappresenta un batch.
file

string

Questo oggetto rappresenta un file.
fine_tuning.job

string

Questo oggetto rappresenta un processo di ottimizzazione.
fine_tuning.job.checkpoint

string

Questo oggetto rappresenta un checkpoint di un processo di ottimizzazione.
fine_tuning.job.event

string

Questo oggetto rappresenta un evento di un processo di ottimizzazione fine.
list

string

Questo oggetto rappresenta un elenco di altri oggetti.
model

string

Questo oggetto rappresenta un modello (può essere un modello di base o ottimizzare il risultato del processo).
upload

string

Questo oggetto rappresenta un caricamento di file.
upload.part

string

Questo oggetto rappresenta parte di un caricamento di file.