Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/). |
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:
- ApiKeyAuth
- ApiKeyAuth_
-
OAuth2Auth (alcances:
https://cognitiveservices.azure.com/.default)
Enumeración de modelos
GET {endpoint}/openai/v1/models
Enumera los modelos disponibles actualmente y proporciona información básica sobre cada uno de ellos, como el propietario y la disponibilidad.
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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/). |
| 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. |
Responses
Código de estado: 200
Descripción: la solicitud se ha realizado correctamente.
| Tipo de contenido | Type | Descripción |
|---|---|---|
| application/json | OpenAI.ListModelsResponse |
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 | No | ||
| type | string | No |
Encabezados de respuesta:
| Encabezado | Tipo | Description |
|---|---|---|
| apim-request-id | string | Identificador de solicitud que se usa para solucionar problemas. |
Recuperar modelo
GET {endpoint}/openai/v1/models/{model}
Recupera una instancia de modelo, proporcionando información básica sobre el modelo, como el propietario y el permiso.
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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/). |
| 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. |
| model | path | Sí | string | Identificador del modelo 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.Model |
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 | No | ||
| type | string | No |
Encabezados de respuesta:
| Encabezado | Tipo | Description |
|---|---|---|
| apim-request-id | string | Identificador de solicitud que se usa para solucionar problemas. |
Eliminación de un modelo
DELETE {endpoint}/openai/v1/models/{model}
Elimina una instancia de modelo.
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://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/). |
| 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. |
| model | path | Sí | string | Identificador del modelo que se va a eliminar. |
Responses
Código de estado: 200
Descripción: la solicitud se ha realizado correctamente.
| Tipo de contenido | Type | Descripción |
|---|---|---|
| application/json | OpenAI.DeleteModelResponse |
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 | No | ||
| type | string | No |
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 | v1preview |
OpenAI.DeleteModelResponse
| Nombre | Tipo | Description | Obligatorio | Predeterminado |
|---|---|---|---|---|
| eliminado | boolean | Sí | ||
| id | string | Sí | ||
| object | string | Sí |
OpenAI.ListModelsResponse
| Nombre | Tipo | Description | Obligatorio | Predeterminado |
|---|---|---|---|---|
| data | matriz de OpenAI.Model | Sí | ||
| object | enum | Valores posibles: list |
Sí |
OpenAI.Model
Modelo
Describe una oferta de modelo de OpenAI que se puede usar con la API.
| Nombre | Tipo | Description | Obligatorio | Predeterminado |
|---|---|---|---|---|
| creado | entero (unixtime) | Marca de tiempo de Unix (en segundos) cuando se creó el modelo. | Sí | |
| id | string | Identificador del modelo, al que se puede hacer referencia en los puntos de conexión de API. | Sí | |
| object | enum | Tipo de objeto, que siempre es "modelo". Valores posibles: model |
Sí | |
| owned_by | string | La organización que posee el modelo. | Sí |