Files - Import

Servicio:: Azure AI Services

Versión de la API:: 2024-10-21

Crea una entidad de archivo mediante la importación de datos desde una dirección URL proporcionada. Los archivos cargados pueden usarse, por ejemplo, para entrenar o evaluar modelos optimizados.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (url)	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre de la cuenta de Azure OpenAI).
api-version	query	True	string	La versión de API solicitada.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
api-key	True	string	Proporcione la clave de cuenta de Azure OpenAI de Cognitive Services aquí.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
content_url	True	string (url)	La dirección URL desde la que descargar el documento (puede ser la dirección URL de SAS de un blob o cualquier otra dirección URL externa accesible con una solicitud GET).
filename	True	string minLength: 1	Nombre del archivo líneas JSON que se va a cargar. Si el `purpose` se establece en "ajustar", cada línea es un registro JSON con campos "prompt" y "completion" que representan los ejemplos de entrenamiento.

Respuestas

Nombre	Tipo	Description
201 Created	File	El archivo se ha creado correctamente. Encabezados Location: string
Other Status Codes	ErrorResponse	Error.

Nombre

Tipo

Description

201 Created

File

El archivo se ha creado correctamente.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Error.

Seguridad

api-key

Proporcione la clave de cuenta de Azure OpenAI de Cognitive Services aquí.

Tipo: apiKey
En: header

Ejemplos

Importing a file with a blob url as source.

Solicitud de ejemplo

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"
}

Respuesta de muestra

status code:: 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"
}

Definiciones

Nombre	Description
Error	Error
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	Archivo
FileImport	FileImport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Propósito
TypeDiscriminator	TypeDiscriminator

Error

Object

Error

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error tal como se definen en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Los detalles del error si están disponibles.
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string minLength: 1	Mensaje de este error.
target	string	Ubicación donde se produjo el error si está disponible.

ErrorCode

Enumeración

ErrorCode

Valor	Description
conflict	La operación solicitada entra en conflicto con el estado de recurso actual.
invalidPayload	Los datos de solicitud no son válidos para esta operación.
forbidden	La operación está prohibida para la clave de usuario o API actual.
notFound	No se encuentra el recurso.
unexpectedEntityState	La operación no se puede ejecutar en el estado del recurso actual.
itemDoesAlreadyExist	El elemento ya existe.
serviceUnavailable	El servicio no está disponible actualmente.
internalFailure	Error interno. Vuelva a intentarlo.
quotaExceeded	Se superó la cuota.
jsonlValidationFailed	Error en la validación de datos jsonl.
fileImportFailed	Error en la importación del archivo.
tooManyRequests	Demasiadas solicitudes. Vuelva a intentarlo más tarde.
unauthorized	La clave de usuario o API actual no está autorizada para la operación.
contentFilter	Se produjo un error en la generación de imágenes como resultado de nuestro sistema de seguridad.

ErrorResponse

Object

ErrorResponse

Nombre	Tipo	Description
error	Error	Error Contenido de error tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Object

Archivo

Nombre	Tipo	Description
bytes	integer (int64)	Tamaño de este archivo cuando está disponible (puede ser NULL). Los tamaños de archivo mayores que 2^53-1 no se admiten para garantizar la compatibilidad con los enteros de JavaScript.
created_at	integer (unixtime)	Marca de tiempo cuando se creó este trabajo o elemento (en épocas unix).
filename	string minLength: 1	Nombre del archivo.
id	string	Identidad de este elemento.
object	TypeDiscriminator	TypeDiscriminator Define el tipo de un objeto .
purpose	Purpose	Propósito Propósito previsto de los documentos cargados. Use "ajuste" para ajustar. Esto nos permite validar el formato del archivo cargado.
status	FileState	FileState Estado de un archivo.
status_details	string	Mensaje de error con detalles en caso de que se produzca un error en el procesamiento de este archivo.

FileImport

Object

FileImport

Nombre	Tipo	Description
content_url	string (url)	La dirección URL desde la que descargar el documento (puede ser la dirección URL de SAS de un blob o cualquier otra dirección URL externa accesible con una solicitud GET).
filename	string minLength: 1	Nombre del archivo líneas JSON que se va a cargar. Si el `purpose` se establece en "ajustar", cada línea es un registro JSON con campos "prompt" y "completion" que representan los ejemplos de entrenamiento.
purpose	Purpose	Propósito Propósito previsto de los documentos cargados. Use "ajuste" para ajustar. Esto nos permite validar el formato del archivo cargado.

FileState

Enumeración

FileState

Valor	Description
uploaded	El archivo se ha cargado, pero aún no se ha procesado. Azure OpenAI no devuelve este estado y solo se expone por motivos de compatibilidad. Se puede clasificar como un estado inactivo.
pending	La operación se creó y no se pone en cola para procesarse en el futuro. Se puede clasificar como un estado inactivo.
running	La operación se ha iniciado para procesarse. Se puede clasificar como un estado activo.
processed	La operación se ha procesado correctamente y está lista para su consumo. Se puede clasificar como un estado terminal.
error	La operación ha completado el procesamiento con un error y no se puede consumir más. Se puede clasificar como un estado terminal.
deleting	La entidad es ni el proceso que se va a eliminar. Azure OpenAI no devuelve este estado y solo se expone por motivos de compatibilidad. Se puede clasificar como un estado activo.
deleted	Se ha eliminado la entidad, pero otras entidades pueden hacer referencia a ellas antes de la eliminación. Se puede clasificar como un estado terminal.

InnerError

Object

InnerError

Nombre	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de error internos tal como se definen en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Enumeración

InnerErrorCode

Valor	Description
invalidPayload	Los datos de solicitud no son válidos para esta operación.

Purpose

Enumeración

Propósito

Valor	Description
fine-tune	Este archivo contiene datos de entrenamiento para un trabajo de ajuste preciso.
fine-tune-results	Este archivo contiene los resultados de un trabajo de ajuste preciso.
assistants	Este archivo contiene datos que se usarán en los asistentes.
assistants_output	Este archivo contiene los resultados de un asistente.
batch	Este archivo contiene los datos de entrada de un lote.
batch_output	Este archivo contiene los resultados de un lote.

TypeDiscriminator

Enumeración

TypeDiscriminator

Valor	Description
list	Este objeto representa una lista de otros objetos.
fine_tuning.job	Este objeto representa un trabajo de ajuste preciso.
file	Este objeto representa un archivo.
fine_tuning.job.event	Este objeto representa un evento de un trabajo de ajuste fino.
fine_tuning.job.checkpoint	Este objeto representa un punto de control de un trabajo de ajuste fino.
model	Este objeto representa un modelo (puede ser un modelo base o ajustar el resultado del trabajo).
batch	Este objeto representa un lote.
upload	Este objeto representa una carga de archivos.
upload.part	Este objeto representa parte de una carga de archivos.

Compartir a través de

Files - Import

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

api-key

Ejemplos

Importing a file with a blob url as source.

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator