Files - Upload
Crea una nueva entidad de archivo cargando datos desde un equipo local. Los archivos cargados se pueden usar, por ejemplo, para entrenar o evaluar modelos ajustados.
POST {endpoint}/openai/files?api-version=2024-02-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
file
|
formData | True |
file |
Obtiene o establece el archivo que se va a cargar en Azure OpenAI. |
purpose
|
formData | True |
El propósito previsto de los documentos cargados. Use "ajuste" para ajustar. Esto nos permite validar el formato del archivo cargado. |
|
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
Media Types: "multipart/form-data"
Nombre | Requerido | Tipo | Description |
---|---|---|---|
api-key | True |
string |
Proporcione aquí la clave de cuenta de Azure OpenAI de Cognitive Services. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
201 Created |
El archivo se ha creado correctamente. Encabezados Location: string |
|
Other Status Codes |
Se produjo un error. |
Seguridad
api-key
Proporcione aquí la clave de cuenta de Azure OpenAI de Cognitive Services.
Tipo:
apiKey
En:
header
Ejemplos
Upload a file.
Solicitud de ejemplo
POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-02-01
Respuesta de muestra
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 |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
Archivo |
File |
FileState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Purpose |
Propósito |
Type |
TypeDiscriminator |
Error
Error
Nombre | Tipo | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Detalles del error si está disponible. |
innererror |
InnerError |
|
message |
string |
Mensaje de este error. |
target |
string |
Ubicación donde se produjo el error si está disponible. |
ErrorCode
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 en la 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
ErrorResponse
Nombre | Tipo | Description |
---|---|---|
error |
Error |
File
Archivo
Nombre | Tipo | Description |
---|---|---|
bytes |
integer |
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 |
Marca de tiempo en la que se creó este trabajo o elemento (en épocas unix). |
filename |
string |
Nombre del archivo. |
id |
string |
Identidad de este elemento. |
object |
TypeDiscriminator |
|
purpose |
Propósito |
|
status |
FileState |
|
status_details |
string |
Mensaje de error con detalles en caso de que se produzca un error en el procesamiento de este archivo. |
FileState
FileState
Nombre | Tipo | Description |
---|---|---|
deleted |
string |
La entidad se ha eliminado, pero es posible que otras entidades hagan referencia a ella 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
InnerError
Nombre | Tipo | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
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
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 de ajuste fino. |
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 fino. |
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). |