Files - List
Obtiene una lista de todos los archivos propiedad del recurso de Azure OpenAI. Estos incluyen el contenido cargado por el usuario como archivos con el propósito "ajustar" para el entrenamiento o la validación de modelos de ajuste, así como archivos generados por el servicio, como "fine-tune-results", que contiene varias métricas para el trabajo de ajuste correspondiente.
GET {endpoint}/openai/files?api-version=2024-05-01-preview
GET {endpoint}/openai/files?purpose={purpose}&api-version=2024-05-01-preview
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. |
purpose
|
query |
Solo devuelve archivos con el propósito dado. |
Encabezado de la solicitud
Nombre | Requerido | Tipo | Description |
---|---|---|---|
api-key | True |
string |
Proporcione aquí la clave de cuenta de Azure OpenAI de Cognitive Services. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Correcto |
|
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
Getting all files owned by this account.
Solicitud de ejemplo
GET https://aoairesource.openai.azure.com/openai/files?api-version=2024-05-01-preview
Respuesta de muestra
{
"data": [
{
"status": "processed",
"bytes": 140,
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
},
{
"status": "processed",
"bytes": 32423,
"purpose": "fine-tune-results",
"filename": "results.csv",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
],
"object": "list"
}
Definiciones
Nombre | Description |
---|---|
Error |
Error |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
Archivo |
File |
Filelist |
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. |
FileList
Filelist
Nombre | Tipo | Description |
---|---|---|
data |
File[] |
La lista de elementos. |
object |
TypeDiscriminator |
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 |
---|---|---|
assistants |
string |
Este archivo contiene datos que se usarán en los asistentes. |
assistants_output |
string |
Este archivo contiene los resultados de un asistente. |
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_tuning.job |
string |
Este objeto representa un trabajo de ajuste preciso. |
fine_tuning.job.checkpoint |
string |
Este objeto representa un punto de control de un trabajo de ajuste fino. |
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). |