Files - Import

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-02-01

Crea una nueva entidad de archivo importando datos de una dirección URL proporcionada. Los archivos cargados se pueden usar, por ejemplo, para entrenar o evaluar modelos ajustados.

POST {endpoint}/openai/files/import?api-version=2024-02-01

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	La dirección URL de 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	Nombre del archivo de líneas JSON que se va a cargar. Si se establece en `purpose` "ajustar", cada línea es un registro JSON con campos "prompt" y "completion" que representan los ejemplos de entrenamiento.
purpose	True	Purpose	Propósito El propósito previsto de los documentos cargados. Use "fine-tune" para ajustar. Esto nos permite validar el formato del archivo cargado.

Respuestas

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

Nombre

Tipo

Description

201 Created

File

El archivo se ha creado correctamente.

Encabezados

Location: string

Other Status Codes

ErrorResponse

Se produjo un 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-02-01


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

{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "status": "notRunning",
  "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

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error tal y 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[]	Detalles del error si están disponibles.
innererror	InnerError	InnerError Error interno tal y como se define en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Mensaje de este error.
target	string	Ubicación donde se produjo el error si está disponible.

ErrorCode

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

ErrorResponse

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

File

Archivo

Nombre	Tipo	Description
bytes	integer	Tamaño de este archivo cuando está disponible (puede ser null). No se admiten tamaños de archivo mayores que 2^53-1 para garantizar la compatibilidad con enteros de JavaScript.
created_at	integer	Marca de tiempo cuando se creó este trabajo o elemento (en épocas unix).
filename	string	Nombre del archivo.
id	string	Identidad de este elemento.
object	TypeDiscriminator	TypeDiscriminator Define el tipo de un objeto .
purpose	Purpose	Propósito El propósito previsto de los documentos cargados. Use "fine-tune" 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

Nombre	Tipo	Description
content_url	string	La dirección URL de 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	Nombre del archivo de líneas JSON que se va a cargar. Si se establece en `purpose` "ajustar", cada línea es un registro JSON con campos "prompt" y "completion" que representan los ejemplos de entrenamiento.
purpose	Purpose	Propósito El propósito previsto de los documentos cargados. Use "fine-tune" para ajustar. Esto nos permite validar el formato del archivo cargado.

FileState

Nombre	Tipo	Description
deleted	string	Se ha eliminado la entidad, pero es posible que otras entidades hagan referencia a ellas antes de la eliminación. Se puede clasificar como un estado terminal.
deleting	string	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.
error	string	La operación ha completado el procesamiento con un error y no se puede consumir más. Se puede clasificar como un estado terminal.
pending	string	La operación se creó y no se pone en cola para procesarse en el futuro. Se puede clasificar como un estado inactivo.
processed	string	La operación se ha procesado correctamente y está lista para su consumo. Se puede clasificar como un estado terminal.
running	string	La operación se ha iniciado para procesarse. Se puede clasificar como un estado activo.
uploaded	string	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.

InnerError

Nombre	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de error internos 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).
innererror	InnerError	InnerError Error interno tal y como se define en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

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

Purpose

Propósito

Nombre	Tipo	Description
fine-tune	string	Este archivo contiene datos de entrenamiento para un trabajo de ajuste preciso.
fine-tune-results	string	Este archivo contiene los resultados de un trabajo de ajuste preciso.

TypeDiscriminator

Nombre	Tipo	Description
file	string	Este objeto representa un archivo.
fine-tune	string	Este objeto representa un trabajo de ajuste preciso.
fine-tune-event	string	Este objeto representa un evento de un trabajo ajustado.
fine_tuning.job	string	Este objeto representa un trabajo de ajuste preciso.
fine_tuning.job.event	string	Este objeto representa un evento de un trabajo de ajuste preciso.
list	string	Este objeto representa una lista de otros objetos.
model	string	Este objeto representa un modelo (puede ser un modelo base o ajustar el resultado del trabajo).

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

Recursos adicionales