Files - Import

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-10-21

Cria uma nova entidade de arquivo importando dados de uma URL fornecida. Arquivos carregados podem, por exemplo, ser usados para treinamento ou avaliação de modelos ajustados.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da sua conta do Azure OpenAI).
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
content_url	True	string	A URL da qual baixar o documento (pode ser a URL SAS de um blob ou qualquer outra url externa acessível com uma solicitação GET).
filename	True	string	O nome do arquivo linhas JSON a ser carregado. Se o `purpose` estiver definido como "ajustar", cada linha será um registro JSON com campos "prompt" e "completion" representando seus exemplos de treinamento.

Respostas

Nome	Tipo	Description
201 Created	File	O arquivo foi criado com êxito. Cabeçalhos Location: string
Other Status Codes	ErrorResponse	Ocorreu um erro.

Nome

Tipo

Description

201 Created

File

O arquivo foi criado com êxito.

Cabeçalhos

Location: string

Other Status Codes

ErrorResponse

Ocorreu um erro.

Segurança

api-key

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

Tipo: apiKey
Em: header

Exemplos

Importing a file with a blob url as source.

Solicitação de exemplo

HTTP

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


{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}

Resposta de exemplo

Código de status:: 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"
}

Definições

Nome	Description
Error	Erro
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	Arquivo
FileImport	FileImport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Propósito
TypeDiscriminator	TypeDiscriminator

Error

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode 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 desse erro.
target	string	O local em que o erro ocorreu se disponível.

ErrorCode

Nome	Tipo	Description
conflict	string	A operação solicitada 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 arquivo.
forbidden	string	A operação é proibida para a chave de usuário/api atual.
internalFailure	string	Erro interno. Tente novamente.
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.
itemDoesAlreadyExist	string	O item já existe.
jsonlValidationFailed	string	Falha na validação de dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Cota excedida.
serviceUnavailable	string	No momento, o serviço não está disponível.
tooManyRequests	string	Muitas solicitações. Tente novamente mais tarde.
unauthorized	string	A chave de usuário/api atual não está autorizada para a operação.
unexpectedEntityState	string	A operação não pode ser executada no estado do recurso atual.

ErrorResponse

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

File

Arquivo

Nome	Tipo	Description
bytes	integer	O tamanho desse arquivo quando disponível (pode ser nulo). Não há suporte para tamanhos de arquivo maiores que 2^53-1 para garantir a compatibilidade com inteiros javaScript.
created_at	integer	Um carimbo de data/hora quando este trabalho ou item foi criado (em épocas unix).
filename	string	O nome do arquivo.
id	string	A identidade deste item.
object	TypeDiscriminator	TypeDiscriminator Define o tipo de um objeto.
purpose	Purpose	Propósito A finalidade pretendida dos documentos carregados. Use "fine-tune" para ajuste fino. Isso nos permite validar o formato do arquivo carregado.
status	FileState	FileState O estado de um arquivo.
status_details	string	A mensagem de erro com detalhes no caso de o processamento desse arquivo falhar.

FileImport

Nome	Tipo	Description
content_url	string	A URL da qual baixar o documento (pode ser a URL SAS de um blob ou qualquer outra url externa acessível com uma solicitação GET).
filename	string	O nome do arquivo linhas JSON a ser carregado. Se o `purpose` estiver definido como "ajustar", cada linha será um registro JSON com campos "prompt" e "completion" representando seus exemplos de treinamento.
purpose	Purpose	Propósito A finalidade pretendida dos documentos carregados. Use "fine-tune" para ajuste fino. Isso nos permite validar o formato do arquivo carregado.

FileState

Nome	Tipo	Description
deleted	string	A entidade foi excluída, mas ainda pode ser referenciada por outras entidades que antecedem a exclusão. Ele pode ser categorizado como um estado terminal.
deleting	string	A entidade é ni o processo a ser excluído. Esse estado não é retornado pelo Azure OpenAI e exposto apenas para compatibilidade. Ele pode ser categorizado como um estado ativo.
error	string	A operação concluiu o processamento com uma falha e não pode ser consumida. Ele pode ser categorizado como um estado terminal.
pending	string	A operação foi criada e não está na fila para ser processada no futuro. Ele pode ser categorizado como um estado inativo.
processed	string	A operação foi processada com êxito e está pronta para consumo. Ele pode ser categorizado como um estado terminal.
running	string	A operação começou a ser processada. Ele pode ser categorizado como um estado ativo.
uploaded	string	O arquivo foi carregado, mas ainda não foi processado. Esse estado não é retornado pelo Azure OpenAI e exposto apenas para compatibilidade. Ele pode ser categorizado como um estado inativo.

InnerError

Nome	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

Nome	Tipo	Description
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.

Purpose

Propósito

Nome	Tipo	Description
assistants	string	Esse arquivo contém dados a serem usados em assistentes.
assistants_output	string	Esse arquivo contém os resultados de um assistente.
batch	string	Esse arquivo contém os dados de entrada de um lote.
batch_output	string	Esse arquivo contém os resultados de um lote.
fine-tune	string	Este arquivo contém dados de treinamento para um trabalho de ajuste fino.
fine-tune-results	string	Esse arquivo contém os resultados de um trabalho de ajuste fino.

TypeDiscriminator

Nome	Tipo	Description
batch	string	Esse objeto representa um lote.
file	string	Esse objeto representa um arquivo.
fine_tuning.job	string	Esse objeto representa um trabalho de ajuste fino.
fine_tuning.job.checkpoint	string	Esse objeto representa um ponto de verificação de um trabalho de ajuste fino.
fine_tuning.job.event	string	Esse objeto representa um evento de um trabalho de ajuste fino.
list	string	Esse objeto representa uma lista de outros objetos.
model	string	Esse objeto representa um modelo (pode ser um modelo base ou ajustar o resultado do trabalho).
upload	string	Esse objeto representa um upload de arquivo.
upload.part	string	Esse objeto representa parte de um upload de arquivo.

Compartilhar via

Files - Import

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

api-key

Exemplos

Importing a file with a blob url as source.

Solicitação de exemplo

Resposta de exemplo

Definições

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Recursos adicionais