Azure OpenAI Files

Versión de API: v1

Server:{endpoint}/openai/v1 — APIs de modelos Fundición de IA de Azure

Variables de servidor:

Variable Predeterminado Description
endpoint Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).

Autenticación

ApiKeyAuth (clave API)

Pasa tu clave API en la api-key cabecera.

ApiKeyAuth_ (clave API)

Pasa tu clave API en la authorization cabecera.

OAuth2Auth (OAuth 2.0)

Flow: implícito

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

Ámbitos:

  • https://cognitiveservices.azure.com/.default

Requisitos de seguridad

Los endpoints aceptan cualquiera de los siguientes métodos de autenticación:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (alcances: https://cognitiveservices.azure.com/.default)

Crear archivo

POST {endpoint}/openai/v1/files

Parámetros de URI

Nombre In Obligatorio Tipo Description
endpoint server Sí string Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).
versión de la API query No string
Valores posibles: v1, preview		 La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud.
v1 si no se especifica lo contrario.

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre Tipo Description Obligatorio Predeterminado
expires_after object Sí
Delimitador └\ AzureFileExpiryAnchor Sí
└segundos entero (int32) Sí
file Objeto File (no nombre de archivo) que se va a cargar. Sí
propósito enum Propósito previsto del archivo cargado. Uno de los siguientes: assistants: se usa en la API batchde asistentes: : se usa en batch API - fine-tune: se usa para la optimización evals- : se usa para conjuntos de datos eval.
Valores posibles: assistants, batch, fine-tune, evals		 Sí

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
bytes integer Tamaño del archivo, en bytes. Sí
fecha_de_creación entero (unixtime) Marca de tiempo de Unix (en segundos) para cuando se creó el archivo. Sí
expires_at entero (unixtime) Marca de tiempo de Unix (en segundos) para cuando expire el archivo. No
filename string El nombre del archivo. Sí
id string Identificador de archivo, al que se puede hacer referencia en los puntos de conexión de API. Sí
object enum Tipo de objeto, que siempre filees .
Valores posibles: file		 Sí
propósito enum Propósito previsto del archivo. Los valores admitidos son assistants, assistants_output, batch, batch_outputy fine-tunefine-tune-results.
Valores posibles: assistants, assistants_output, batch, batch_output, fine-tune, , , fine-tune-resultsevals		 Sí
status enum
Valores posibles: uploaded, pending, running, processed, error, , , deletingdeleted		 Sí
detalles_del_estado string (en desuso) Deprecated. Para obtener más información sobre por qué se produjo un error en la validación de un archivo de entrenamiento de ajuste preciso, consulte el error campo en fine_tuning.job. No

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
código string o null Sí
inner_error No
message string Sí
param string o null Sí
type string Sí

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Examples

Example

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

Enumerar archivos

GET {endpoint}/openai/v1/files

Parámetros de URI

Nombre In Obligatorio Tipo Description
endpoint server Sí string Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).
versión de la API query No string
Valores posibles: v1, preview		 La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud.
v1 si no se especifica lo contrario.
propósito query No string
Serialización: explotar: falso
limit query No integer
Serialización: explotar: falso
order query No string
Valores posibles: asc, desc
Serialización: explotar: falso
después query No string
Serialización: explotar: falso

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido Type Descripción
application/json OpenAI.ListFilesResponse

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
código string o null Sí
inner_error No
message string Sí
param string o null Sí
type string Sí

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Recuperar archivo

GET {endpoint}/openai/v1/files/{file_id}

Parámetros de URI

Nombre In Obligatorio Tipo Description
endpoint server Sí string Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).
versión de la API query No string
Valores posibles: v1, preview		 La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud.
v1 si no se especifica lo contrario.
ID del archivo path Sí string Identificador del archivo que se va a usar para esta solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
bytes integer Tamaño del archivo, en bytes. Sí
fecha_de_creación entero (unixtime) Marca de tiempo de Unix (en segundos) para cuando se creó el archivo. Sí
expires_at entero (unixtime) Marca de tiempo de Unix (en segundos) para cuando expire el archivo. No
filename string El nombre del archivo. Sí
id string Identificador de archivo, al que se puede hacer referencia en los puntos de conexión de API. Sí
object enum Tipo de objeto, que siempre filees .
Valores posibles: file		 Sí
propósito enum Propósito previsto del archivo. Los valores admitidos son assistants, assistants_output, batch, batch_outputy fine-tunefine-tune-results.
Valores posibles: assistants, assistants_output, batch, batch_output, fine-tune, , , fine-tune-resultsevals		 Sí
status enum
Valores posibles: uploaded, pending, running, processed, error, , , deletingdeleted		 Sí
detalles_del_estado string (en desuso) Deprecated. Para obtener más información sobre por qué se produjo un error en la validación de un archivo de entrenamiento de ajuste preciso, consulte el error campo en fine_tuning.job. No

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
código string o null Sí
inner_error No
message string Sí
param string o null Sí
type string Sí

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Eliminar archivo

DELETE {endpoint}/openai/v1/files/{file_id}

Parámetros de URI

Nombre In Obligatorio Tipo Description
endpoint server Sí string Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).
versión de la API query No string
Valores posibles: v1, preview		 La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud.
v1 si no se especifica lo contrario.
ID del archivo path Sí string Identificador del archivo que se va a usar para esta solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido Type Descripción
application/json OpenAI.DeleteFileResponse

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
código string o null Sí
inner_error No
message string Sí
param string o null Sí
type string Sí

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Descargar archivo

GET {endpoint}/openai/v1/files/{file_id}/content

Parámetros de URI

Nombre In Obligatorio Tipo Description
endpoint server Sí string Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).
versión de la API query No string
Valores posibles: v1, preview		 La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud.
v1 si no se especifica lo contrario.
ID del archivo path Sí string Identificador del archivo que se va a usar para esta solicitud.

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido Type Descripción
application/octet-stream object

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
código string o null Sí
inner_error No
message string Sí
param string o null Sí
type string Sí

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Components

AzureAIFoundryModelsApiVersion

Propiedad Value
Type string
Valores v1
preview

AzureFileExpiryAnchor

Propiedad Value
Type string
Valores created_at

OpenAI.CreateFileRequest

Nombre Tipo Description Obligatorio Predeterminado
expires_after object Sí
Delimitador └\ AzureFileExpiryAnchor Sí
└segundos entero (int32) Sí
file Objeto File (no nombre de archivo) que se va a cargar. Sí
propósito enum Propósito previsto del archivo cargado. Uno de los siguientes: assistants: se usa en la API batchde asistentes: : se usa en batch API - fine-tune: se usa para la optimización evals- : se usa para conjuntos de datos eval.
Valores posibles: assistants, batch, fine-tune, evals		 Sí

OpenAI.DeleteFileResponse

Nombre Tipo Description Obligatorio Predeterminado
eliminado boolean Sí
id string Sí
object enum
Valores posibles: file		 Sí

OpenAI.ListFilesResponse

Nombre Tipo Description Obligatorio Predeterminado
data matriz de OpenAI.OpenAIFile Sí
first_id string Sí
has_more boolean Sí
last_id string Sí
object string Sí

OpenAI.OpenAIFile

OpenAIFile

El File objeto representa un documento que se ha cargado en OpenAI.

Nombre Tipo Description Obligatorio Predeterminado
bytes integer Tamaño del archivo, en bytes. Sí
fecha_de_creación entero (unixtime) Marca de tiempo de Unix (en segundos) para cuando se creó el archivo. Sí
expires_at entero (unixtime) Marca de tiempo de Unix (en segundos) para cuando expire el archivo. No
filename string El nombre del archivo. Sí
id string Identificador de archivo, al que se puede hacer referencia en los puntos de conexión de API. Sí
object enum Tipo de objeto, que siempre filees .
Valores posibles: file		 Sí
propósito enum Propósito previsto del archivo. Los valores admitidos son assistants, assistants_output, batch, batch_outputy fine-tunefine-tune-results.
Valores posibles: assistants, assistants_output, batch, batch_output, fine-tune, , , fine-tune-resultsevals		 Sí
status enum
Valores posibles: uploaded, pending, running, processed, error, , , deletingdeleted		 Sí
detalles_del_estado string (en desuso) Deprecated. Para obtener más información sobre por qué se produjo un error en la validación de un archivo de entrenamiento de ajuste preciso, consulte el error campo en fine_tuning.job. No
  • Last updated on