Models - List

Referência

Service:: Azure AI Services

API Version:: 2023-12-01-preview

Obtém uma lista de todos os modelos acessíveis pelo recurso OpenAI do Azure. Eles incluem modelos base, bem como todos os modelos ajustados concluídos com êxito pertencentes ao recurso OpenAI do Azure.

GET {endpoint}/openai/models?api-version=2023-12-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string url	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome da conta do Azure OpenAI).
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
api-key	True	string	Forneça a chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Respostas

Nome	Tipo	Description
200 OK	ModelList	Êxito
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

api-key

Forneça a chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Type: apiKey
In: header

Exemplos

Getting all models owned by account.

Sample Request

HTTP

GET https://aoairesource.openai.azure.com/openai/models?api-version=2023-12-01-preview

Sample Response

Status code:: 200

{
  "data": [
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "model"
    },
    {
      "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",
      "status": "succeeded",
      "created_at": 1646126127,
      "updated_at": 1646127311,
      "object": "model"
    }
  ],
  "object": "list"
}

Definições

Nome	Description
Capabilities	Funcionalidades
Deprecation	Reprovação
Error	Erro
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	LifeCycleStatus
Model	Modelar
ModelList	ModelList
TypeDiscriminator	TypeDiscriminator

Capabilities

Funcionalidades

Nome	Tipo	Description
chat_completion	boolean	Um valor que indica se um modelo dá suporte à conclusão de chat.
completion	boolean	Um valor que indica se um modelo dá suporte à conclusão.
embeddings	boolean	Um valor que indica se um modelo dá suporte a inserções.
fine_tune	boolean	Um valor que indica se um modelo pode ser usado para ajuste fino.
inference	boolean	Um valor que indica se um modelo pode ser implantado.

Deprecation

Reprovação

Nome	Tipo	Description
fine_tune	integer	A data de término do suporte a ajuste fino desse modelo. Será `null` para modelos de ajuste fino.
inference	integer	A data de término do suporte à inferência desse modelo.

Error

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode Códigos de erro conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Os detalhes do erro, se disponíveis.
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem desse erro.
target	string	O local em que o erro ocorreu, se disponível.

ErrorCode

Nome	Tipo	Description
conflict	string	A operação solicitada está em conflito com o estado atual do recurso.
contentFilter	string	A geração de imagens falhou como resultado do nosso sistema de segurança.
fileImportFailed	string	Falha na importação do arquivo.
forbidden	string	A operação é proibida para a chave de usuário/api atual.
internalFailure	string	Erro interno. Tente novamente.
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.
itemDoesAlreadyExist	string	O item já existe.
jsonlValidationFailed	string	Falha na validação de dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Cota excedida.
serviceUnavailable	string	No momento, o serviço não está disponível.
tooManyRequests	string	Solicitações demais. Tente novamente mais tarde.
unauthorized	string	A chave de usuário/api atual não está autorizada para a operação.
unexpectedEntityState	string	A operação não pode ser executada no estado do recurso atual.

ErrorResponse

Nome	Tipo	Description
error	Error	Erro Conteúdo do erro conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FineTuningState

Nome	Tipo	Description
cancelled	string	A operação foi cancelada e está incompleta. Ele pode ser categorizado como um estado terminal.
created	string	A operação foi criada. Esse estado não é retornado pelo OpenAI do Azure e exposto apenas para compatibilidade. Ele pode ser categorizado como um estado inativo.
failed	string	A operação concluiu o processamento com uma falha e não pode ser consumida mais. Ele pode ser categorizado como um estado terminal.
pending	string	A operação ainda não está na fila para ser processada no futuro. Ele pode ser categorizado como um estado inativo.
running	string	A operação começou a ser processada. Ele pode ser categorizado como um estado ativo.
succeeded	string	A operação foi processada com êxito e está pronta para consumo. Ele pode ser categorizado como um estado terminal.

InnerError

Nome	Tipo	Description
code	InnerErrorCode	InnerErrorCode Códigos de erro internos, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erro interno, conforme definido nas diretrizes rest da Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nome	Tipo	Description
invalidPayload	string	Os dados da solicitação são inválidos para esta operação.

LifeCycleStatus

Nome	Tipo	Description
generally-available	string	O modelo está em disponibilidade geral.
preview	string	O modelo está em versão prévia e coberto pelos termos de versão prévia do serviço.

Model

Modelar

Nome	Tipo	Description
capabilities	Capabilities	Funcionalidades As funcionalidades de um modelo base ou de ajuste fino.
created_at	integer	Um carimbo de data/hora quando esse trabalho ou item foi criado (em épocas unix).
deprecation	Deprecation	Reprovação Define as datas de substituição para os diferentes casos de uso de um modelo. Normalmente, os modelos base dão suporte a 1 ano de ajuste fino após a criação. Normalmente, há suporte para inferência 2 anos após a criação de modelos básicos ou ajustados. As datas exatas são especificadas nas propriedades.
fine_tune	string	A identidade do trabalho de ajuste fino (fine-tune-id) se este for um modelo de ajuste fino; caso contrário `null`, .
id	string	A identidade deste item.
lifecycle_status	LifeCycleStatus	LifeCycleStatus O ciclo de vida status de um modelo. Observação: um modelo pode ser promovido de "versão prévia" para "em disponibilidade geral", mas nunca de "em disponibilidade geral" para "versão prévia".
model	string	A identidade do modelo base (id do modelo) se esse for um modelo de ajuste fino; caso contrário `null`, .
object	TypeDiscriminator	TypeDiscriminator Define o tipo de um objeto .
status	FineTuningState	FineTuningState O estado de um objeto finetunes ou trabalho de ajuste fino.
updated_at	integer	Um carimbo de data/hora quando esse trabalho ou item foi modificado por último (em épocas do unix).

ModelList

Nome	Tipo	Description
data	Model[]	A lista de itens.
object	TypeDiscriminator	TypeDiscriminator Define o tipo de um objeto .

TypeDiscriminator

Nome	Tipo	Description
file	string	Esse objeto representa um arquivo.
fine-tune	string	Esse objeto representa um trabalho de ajuste fino.
fine-tune-event	string	Esse objeto representa um evento de um trabalho de ajuste fino.
fine_tuning.job	string	Esse objeto representa um trabalho de ajuste fino.
fine_tuning.job.event	string	Esse objeto representa um evento de um trabalho de ajuste fino.
list	string	Esse objeto representa uma lista de outros objetos.
model	string	Esse objeto representa um modelo (pode ser um modelo base ou ajustar o resultado do trabalho).

Compartilhar via