Files - Delete

Servizio:

Azure AI Services

Versione API:

2024-10-21

Elimina il file con l'ID file specificato. L'eliminazione è consentita anche se è stato usato un file, ad esempio come file di training in un processo di ottimizzazione.

DELETE {endpoint}/openai/files/{file-id}?api-version=2024-10-21

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
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.
file-id	path	True	string	Identificatore del file.
api-version	query	True	string	Versione dell'API richiesta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
api-key	True	string	Specificare qui la chiave dell'account OpenAI di Servizi cognitivi di Azure.

Risposte

Nome	Tipo	Descrizione
200 OK	FileDelete	Il file è stato eliminato correttamente.
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

Deleting a file.

Esempio di richiesta

HTTP

DELETE https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099?api-version=2024-10-21

Risposta di esempio

Codice di stato:

200

{
  "object": "file",
  "deleted": true,
  "id": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Definizioni

Nome	Descrizione
Error	Errore
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	InnerError
InnerErrorCode	InnerErrorCode
TypeDiscriminator	TypeDiscriminator

Error

Object

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 minLength: 1	Messaggio di questo errore.
target	string	Posizione in cui si è verificato l'errore, se disponibile.

ErrorCode

Enumerazione

ErrorCode

Valore	Descrizione
conflict	L'operazione richiesta è in conflitto con lo stato della risorsa corrente.
invalidPayload	I dati della richiesta non sono validi per questa operazione.
forbidden	L'operazione non è consentita per la chiave utente/API corrente.
notFound	La risorsa non viene trovata.
unexpectedEntityState	L'operazione non può essere eseguita nello stato della risorsa corrente.
itemDoesAlreadyExist	L'elemento esiste già.
serviceUnavailable	Il servizio non è attualmente disponibile.
internalFailure	Errore interno. Riprovare.
quotaExceeded	Quota superata.
jsonlValidationFailed	La convalida dei dati jsonl non è riuscita.
fileImportFailed	Importazione del file non riuscita.
tooManyRequests	Troppe richieste. Riprovare più tardi.
unauthorized	La chiave utente/API corrente non è autorizzata per l'operazione.
contentFilter	La generazione di immagini non è riuscita a causa del nostro sistema di sicurezza.

ErrorResponse

Object

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).

FileDelete

Object

FileDelete

Nome	Tipo	Descrizione
deleted	boolean	Valore che indica se ottiene se il file è stato eliminato.
id	string minLength: 1	ID file eliminato.
object	TypeDiscriminator	TypeDiscriminator Definisce il tipo di un oggetto .

InnerError

Object

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

Enumerazione

InnerErrorCode

Valore	Descrizione
invalidPayload	I dati della richiesta non sono validi per questa operazione.

TypeDiscriminator

Enumerazione

TypeDiscriminator

Valore	Descrizione
list	Questo oggetto rappresenta un elenco di altri oggetti.
fine_tuning.job	Questo oggetto rappresenta un processo di ottimizzazione.
file	Questo oggetto rappresenta un file.
fine_tuning.job.event	Questo oggetto rappresenta un evento di un processo di ottimizzazione fine.
fine_tuning.job.checkpoint	Questo oggetto rappresenta un checkpoint di un processo di ottimizzazione.
model	Questo oggetto rappresenta un modello (può essere un modello di base o ottimizzare il risultato del processo).
batch	Questo oggetto rappresenta un batch.
upload	Questo oggetto rappresenta un caricamento di file.
upload.part	Questo oggetto rappresenta parte di un caricamento di file.