Files - Upload
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-02-01
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 |
Scopo previsto dei documenti caricati. Usare "ottimizzare" per ottimizzare l'ottimizzazione. Ciò consente di 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 Azure OpenAI di Servizi cognitivi. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
201 Created |
Il file è stato creato correttamente. Intestazioni Location: string |
|
Other Status Codes |
Si è verificato un errore. |
Sicurezza
api-key
Specificare qui la chiave dell'account Azure OpenAI di Servizi cognitivi.
Tipo:
apiKey
In:
header
Esempio
Upload a file.
Esempio di richiesta
POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-02-01
Risposta di esempio
location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"status": "notRunning",
"created_at": 1646126127,
"object": "file"
}
Definizioni
Nome | Descrizione |
---|---|
Error |
Errore |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
File |
File |
FileState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Purpose |
Scopo |
Type |
TypeDiscriminator |
Error
Errore
Nome | Tipo | Descrizione |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Dettagli dell'errore se disponibile. |
innererror |
InnerError |
|
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 di 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 |
Numero eccessivo di richieste. Riprovare più tardi. |
unauthorized |
string |
La chiave utente/API corrente non è autorizzata per l'operazione. |
unexpectedEntityState |
string |
Impossibile eseguire l'operazione nello stato della risorsa corrente. |
ErrorResponse
ErrorResponse
Nome | Tipo | Descrizione |
---|---|---|
error |
Errore |
File
File
Nome | Tipo | Descrizione |
---|---|---|
bytes |
integer |
Le dimensioni di questo file quando sono disponibili (possono essere null). Le dimensioni dei file superiori a 2^53-1 non sono supportate per garantire la compatibilità con gli interi JavaScript. |
created_at |
integer |
Timestamp quando questo processo o elemento è stato creato (in epoche unix). |
filename |
string |
Nome del file. |
id |
string |
Identità di questo elemento. |
object |
TypeDiscriminator |
|
purpose |
Scopo |
|
status |
FileState |
|
status_details |
string |
Messaggio di errore con dettagli nel caso in cui l'elaborazione di questo file non sia riuscita. |
FileState
FileState
Nome | Tipo | Descrizione |
---|---|---|
deleted |
string |
L'entità è stata eliminata, ma può comunque essere fatto riferimento ad altre entità che precedono l'eliminazione. Può essere classificato 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 classificato come stato attivo. |
error |
string |
L'operazione ha completato l'elaborazione con un errore e non può essere ulteriormente utilizzata. Può essere classificato come stato terminale. |
pending |
string |
L'operazione è stata creata e non è in coda da elaborare in futuro. Può essere classificato come stato inattivo. |
processed |
string |
L'operazione è stata elaborata correttamente ed è pronta per l'utilizzo. Può essere classificato come stato terminale. |
running |
string |
L'operazione è stata avviata per l'elaborazione. Può essere classificato 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 classificato come stato inattivo. |
InnerError
InnerError
Nome | Tipo | Descrizione |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Nome | Tipo | Descrizione |
---|---|---|
invalidPayload |
string |
I dati della richiesta non sono validi per questa operazione. |
Purpose
Scopo
Nome | Tipo | Descrizione |
---|---|---|
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 |
---|---|---|
file |
string |
Questo oggetto rappresenta un file. |
fine-tune |
string |
Questo oggetto rappresenta un processo di ottimizzazione. |
fine-tune-event |
string |
Questo oggetto rappresenta un evento di un processo di ottimizzazione fine. |
fine_tuning.job |
string |
Questo oggetto rappresenta 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). |