Files - Delete

Referência

Service:: Azure AI Services

API Version:: 2024-02-01

Elimina o ficheiro com o ID de ficheiro especificado. A eliminação também é permitida se um ficheiro tiver sido utilizado, por exemplo, como ficheiro de preparação numa tarefa de otimização.

DELETE {endpoint}/openai/files/{file-id}?api-version=2024-02-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da sua conta OpenAI do Azure).
file-id	path	True	string	O identificador do ficheiro.
api-version	query	True	string	A versão da API pedida.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
api-key	True	string	Forneça a sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Respostas

Name	Tipo	Description
204 No Content		O ficheiro foi eliminado com êxito.
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

api-key

Forneça a sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Type: apiKey
In: header

Exemplos

Deleting a file.

Sample Request

HTTP

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

Sample Response

Status code:: 204

Definições

Name	Description
Error	Erro
ErrorCode	CódigoDoErro
ErrorResponse	ErrorResponse
InnerError	InnerError
InnerErrorCode	InnerErrorCode

Error

Erro

Name	Tipo	Description
code	ErrorCode	CódigoDoErro Códigos de erro conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Os detalhes do erro, se disponíveis.
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem deste erro.
target	string	A localização onde ocorreu o erro, se disponível.

ErrorCode

CódigoDoErro

Name	Tipo	Description
conflict	string	A operação pedida entra em conflito com o estado do recurso atual.
contentFilter	string	A geração de imagens falhou como resultado do nosso sistema de segurança.
fileImportFailed	string	Falha na importação do ficheiro.
forbidden	string	A operação é proibida para a chave de utilizador/api atual.
internalFailure	string	Erro interno. Tente novamente.
invalidPayload	string	Os dados do pedido são inválidos para esta operação.
itemDoesAlreadyExist	string	O item já existe.
jsonlValidationFailed	string	Falha na validação dos dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Quota excedida.
serviceUnavailable	string	O serviço não está atualmente disponível.
tooManyRequests	string	Demasiados pedidos. Repita mais tarde.
unauthorized	string	A chave de utilizador/api atual não está autorizada para a operação.
unexpectedEntityState	string	Não é possível executar a operação no estado do recurso atual.

ErrorResponse

Name	Tipo	Description
error	Error	Erro Conteúdo do erro conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerError

Name	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de erro internos, conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes REST da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Tipo	Description
invalidPayload	string	Os dados do pedido são inválidos para esta operação.

Partilhar via