Files - Upload File

Carga un archivo para que lo usen otras operaciones.

POST {endpoint}/files?api-version=v1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
file	formData	True	file	Los datos del archivo, en bytes.
purpose	formData	True	FilePurpose	El propósito previsto del archivo cargado. Utilícelo `assistants` para archivos de agentes y mensajes, `vision` para entradas de archivos de imagen de agentes, `batch` para la API de Batch y `fine-tune` para el ajuste.
filename	formData		string	El nombre del archivo.
endpoint	path	True	string (uri)	Punto final del proyecto en forma de: https://.services.ai.azure.com/api/projects/
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Nombre	Tipo	Description
200 OK	FileInfo	Una representación del archivo cargado.
Other Status Codes	AgentV1Error	Una respuesta de error inesperada.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Nombre	Description
https://ai.azure.com/.default

Nombre	Description
AgentErrorDetail	Describe la información de error devuelta por la API de agentes.
AgentV1Error	Carga de error devuelta por la API de agentes.
FileInfo	Representa un agente que puede llamar al modelo y usar herramientas.
FilePurpose	Los valores posibles que denotan el uso previsto de un archivo.
FileState	Estado del archivo.

Object

Describe la información de error devuelta por la API de agentes.

Nombre	Tipo	Description
code	string	Código de error legible por máquina.
message	string	Descripción legible del error.
param	string	Nombre del parámetro que causó el error, si corresponde.
type	string	Identificador de tipo de error (p. ej. `invalid_request_error`).

Object

Carga de error devuelta por la API de agentes.

Nombre	Tipo	Description
error	AgentErrorDetail	Representa el error.

Object

Representa un agente que puede llamar al modelo y usar herramientas.

Nombre	Tipo	Description
bytes	integer (int32)	Tamaño del archivo, en bytes.
created_at	integer (unixtime)	Marca de tiempo de Unix, en segundos, que representa cuándo se creó este objeto.
filename	string	El nombre del archivo.
id	string	Identificador al que se puede hacer referencia en puntos de conexión de API.
object	enum: file	Tipo de objeto, que siempre es "file".
purpose	FilePurpose	Propósito previsto de un archivo.
status	FileState	Estado del archivo. Este campo solo está disponible en Azure OpenAI.
status_details	string	Mensaje de error con detalles en caso de que se produzca un error en el procesamiento de este archivo. Este campo solo está disponible en Azure OpenAI.

Enumeración

Los valores posibles que denotan el uso previsto de un archivo.

Valor	Description
assistants	Indica que un archivo se utiliza como entrada para los agentes.
assistants_output	Indica que los agentes utilizan un archivo como salida.
vision	Indica que se utiliza un archivo como entrada para una operación de visión.

Enumeración

Estado del archivo.

Valor	Description
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.
deleting	La entidad está en proceso de eliminación. Azure OpenAI no devuelve este estado y solo se expone por motivos de compatibilidad. Se puede clasificar como un estado activo.
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.
pending	La operación se creó y no se pone en cola para procesarse en el futuro. Se puede clasificar como un estado inactivo.
processed	La operación se ha procesado con éxito y está lista para el consumo. Se puede clasificar como un estado terminal.
running	La operación se ha iniciado para procesarse. Se puede clasificar como un estado activo.
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.