Models - List

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2024-10-21

Obtiene una lista de todos los modelos a los que puede acceder el recurso de Azure OpenAI. Estos incluyen modelos base, así como todos los modelos ajustados completados correctamente que pertenecen al recurso de Azure OpenAI.

GET {endpoint}/openai/models?api-version=2024-10-21

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.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
api-key	True	string	Proporcione la clave de cuenta de Azure OpenAI de Cognitive Services aquí.

Respuestas

Nombre	Tipo	Description
200 OK	ModelList	Éxito
Other Status Codes	ErrorResponse	Error.

Seguridad

api-key

Proporcione la clave de cuenta de Azure OpenAI de Cognitive Services aquí.

Tipo: apiKey
En: header

Ejemplos

Getting all models owned by account.

Solicitud de ejemplo

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2024-10-21

Respuesta de muestra

status code:: 200

{
  "data": [
    {
      "status": "succeeded",
      "capabilities": {
        "fine_tune": true,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "fine_tune": 1677662127,
        "inference": 1709284527
      },
      "id": "curie",
      "created_at": 1646126127,
      "object": "model"
    },
    {
      "status": "succeeded",
      "model": "curie",
      "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "capabilities": {
        "fine_tune": false,
        "inference": true,
        "completion": true,
        "chat_completion": false,
        "embeddings": false
      },
      "lifecycle_status": "generally-available",
      "deprecation": {
        "inference": 1709284527
      },
      "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
      "created_at": 1646126127,
      "object": "model"
    }
  ],
  "object": "list"
}

Definiciones

Nombre	Description
Capabilities	Capacidades
Deprecation	Desaprobación
Error	Error
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modelo
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Capacidades

Nombre	Tipo	Description
chat_completion	boolean	Valor que indica si un modelo admite la finalización del chat.
completion	boolean	Valor que indica si un modelo admite la finalización.
embeddings	boolean	Valor que indica si un modelo admite incrustaciones.
fine_tune	boolean	Valor que indica si se puede usar un modelo para ajustar correctamente.
inference	boolean	Valor que indica si se puede implementar un modelo.

Deprecation

Desaprobación

Nombre	Tipo	Description
fine_tune	integer	Fecha de finalización de la compatibilidad de ajuste de este modelo. Se `null` para ajustar los modelos.
inference	integer	Fecha de finalización de la compatibilidad con la inferencia de este modelo.

Error

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error tal como se definen en las directrices de REST de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Los detalles del error si están disponibles.
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Mensaje de este error.
target	string	Ubicación donde se produjo el error si está disponible.

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. Vuelva a intentarlo.
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	Se superó la cuota.
serviceUnavailable	string	El servicio no está disponible actualmente.
tooManyRequests	string	Demasiadas solicitudes. Vuelva a intentarlo 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

Nombre	Tipo	Description
error	Error	Error Contenido de error tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Nombre	Tipo	Description
cancelled	string	La operación se ha cancelado y está incompleta. Se puede clasificar como un estado terminal.
created	string	Se creó la operación. Azure OpenAI no devuelve este estado y solo se expone por motivos de compatibilidad. Se puede clasificar como un estado inactivo.
failed	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 aún no está en cola para procesarse en el futuro. Se puede clasificar como un estado inactivo.
running	string	La operación se ha iniciado para procesarse. Se puede clasificar como un estado activo.
succeeded	string	La operación se ha procesado correctamente y está lista para su consumo. Se puede clasificar como un estado terminal.

InnerError

Nombre	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de error internos tal como se definen en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Error interno tal como se define en las directrices rest de Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nombre	Tipo	Description
invalidPayload	string	Los datos de solicitud no son válidos para esta operación.

LifeCycleStatus

Nombre	Tipo	Description
generally-available	string	El modelo está disponible con carácter general.
preview	string	El modelo está en versión preliminar y está cubierto por los términos de la versión preliminar del servicio.

Model

Modelo

Nombre	Tipo	Description
capabilities	Capabilities	Capacidades Las funcionalidades de un modelo base o de ajuste preciso.
created_at	integer	Marca de tiempo cuando se creó este trabajo o elemento (en épocas unix).
deprecation	Deprecation	Desaprobación Define las fechas de desuso para los distintos casos de uso de un modelo. Normalmente, los modelos base admiten 1 año de ajuste fino después de la creación. Normalmente, la inferencia se admite 2 años después de la creación de modelos base o optimizados. Las fechas exactas se especifican en las propiedades.
fine_tune	string	La identidad del trabajo de ajuste (fine-tune-id) si se trata de un modelo de ajuste preciso; de lo contrario, `null`.
id	string	Identidad de este elemento.
lifecycle_status	LifeCycleStatus	LifeCycleStatus Estado del ciclo de vida de un modelo. Nota: Un modelo se puede promover de "versión preliminar" a "disponible con carácter general", pero nunca de "disponible con carácter general" a "versión preliminar".
model	string	La identidad del modelo base (model-id) si se trata de un modelo de ajuste preciso; de lo contrario, `null`.
object	TypeDiscriminator	TypeDiscriminator Define el tipo de un objeto .
status	FineTuningState	FineTuningState Estado de un objeto finetunes o un trabajo de ajuste fino.

ModelList

Nombre	Tipo	Description
data	Model[]	Lista de elementos.
object	TypeDiscriminator	TypeDiscriminator Define el tipo de un objeto .

TypeDiscriminator

Nombre	Tipo	Description
batch	string	Este objeto representa un lote.
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).
upload	string	Este objeto representa una carga de archivos.
upload.part	string	Este objeto representa parte de una carga de archivos.

Compartir a través de