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. Os ficheiros carregados podem, por exemplo, ser utilizados para formação ou avaliação de modelos ajustados.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade de Serviços Cognitivos suportados (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 do Pedido

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

Corpo do Pedido

Name	Necessá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 JSON Lines arquivo a ser carregado. Se o `purpose` estiver definido como "ajustar", cada linha será um registro JSON com campos "prompt" e "conclusão" representando seus exemplos de treinamento.

Respostas

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

Name

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.

Pedido de amostra

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 da amostra

Código de estado:: 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

Name	Description
Error	Erro
ErrorCode	Código de erro
ErrorResponse	ErrorResponse
File	Ficheiro
FileImport	FileImport
FileState	Estado do arquivo
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Finalidade
TypeDiscriminator	TipoDiscriminador

Error

Erro

Name	Tipo	Description
code	ErrorCode	Código de erro Códigos de erro, conforme definido nas diretrizes do Microsoft REST (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 do Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem deste erro.
target	string	O local onde o erro aconteceu, se disponível.

ErrorCode

Código de erro

Name	Tipo	Description
conflict	string	A operação solicitada entra em conflito com o estado atual do recurso.
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. Por favor, 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 dos dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Quota excedida.
serviceUnavailable	string	O serviço não está disponível no momento.
tooManyRequests	string	Demasiados pedidos. 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

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

File

Ficheiro

Name	Tipo	Description
bytes	integer	O tamanho deste 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	TipoDiscriminador Define o tipo de um objeto.
purpose	Purpose	Finalidade A finalidade pretendida dos documentos carregados. Use "ajuste fino" para ajuste fino. Isto permite-nos validar o formato do ficheiro carregado.
status	FileState	Estado do arquivo O estado de um arquivo.
status_details	string	A mensagem de erro com detalhes no processamento de caso deste arquivo falhou.

FileImport

Name	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 JSON Lines arquivo a ser carregado. Se o `purpose` estiver definido como "ajustar", cada linha será um registro JSON com campos "prompt" e "conclusão" representando seus exemplos de treinamento.
purpose	Purpose	Finalidade A finalidade pretendida dos documentos carregados. Use "ajuste fino" para ajuste fino. Isto permite-nos validar o formato do ficheiro carregado.

FileState

Estado do arquivo

Name	Tipo	Description
deleted	string	A entidade foi excluída, mas ainda pode ser referenciada por outras entidades anteriores à exclusão. Pode ser categorizado como um estado terminal.
deleting	string	A entidade é o processo a ser excluído. Esse estado não é retornado pelo Azure OpenAI e exposto apenas para compatibilidade. Pode ser categorizado como um estado ativo.
error	string	A operação concluiu o processamento com uma falha e não pode ser consumida mais. 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. Pode ser categorizado como um estado inativo.
processed	string	A operação foi processada com sucesso e está pronta para consumo. Pode ser categorizado como um estado terminal.
running	string	A operação já começou a ser processada. Pode ser categorizado como um estado ativo.
uploaded	string	O ficheiro foi carregado, mas ainda não foi processado. Esse estado não é retornado pelo Azure OpenAI e exposto apenas para compatibilidade. Pode ser categorizado como um estado inativo.

InnerError

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

InnerErrorCode

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

Purpose

Finalidade

Name	Tipo	Description
assistants	string	Este ficheiro contém dados a utilizar nos assistentes.
assistants_output	string	Este ficheiro contém os resultados de um assistente.
batch	string	Este arquivo contém os dados de entrada para um lote.
batch_output	string	Este ficheiro 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	Este arquivo contém os resultados de um trabalho de ajuste fino.

TypeDiscriminator

TipoDiscriminador

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

Partilhar via

Files - Import

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

api-key

Exemplos

Importing a file with a blob url as source.

Pedido de amostra

Resposta da amostra

Definições

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Recursos adicionais