Models - List

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-10-21

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

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

Parâmetros do URI

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

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
api-key	True	string	Forneça sua chave de conta do Azure OpenAI dos Serviços Cognitivos aqui.

Respostas

Name	Tipo	Description
200 OK	ModelList	Sucesso
Other Status Codes	ErrorResponse	Ocorreu um erro.

Segurança

api-key

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

Tipo: apiKey
Em: header

Exemplos

Getting all models owned by account.

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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"
}

Definições

Name	Description
Capabilities	Capacidades
Deprecation	Preterição
Error	Erro
ErrorCode	Código de erro
ErrorResponse	ErrorResponse
FineTuningState	FineTuningState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
LifeCycleStatus	Status do Ciclo de Vida
Model	Modelo
ModelList	Lista de modelos
TypeDiscriminator	TipoDiscriminador

Capabilities

Capacidades

Name	Tipo	Description
chat_completion	boolean	Um valor que indica se um modelo suporta a conclusão de chat.
completion	boolean	Um valor que indica se um modelo suporta a conclusão.
embeddings	boolean	Um valor que indica se um modelo suporta incorporaçõ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

Preterição

Name	Tipo	Description
fine_tune	integer	A data final do suporte de ajuste fino deste modelo. Será `null` para modelos de ajuste fino.
inference	integer	A data final de inferência suporta este modelo.

Error

Erro

Name	Tipo	Description
code	ErrorCode	Código de erro Códigos de erro, conforme definido nas diretrizes do Microsoft REST (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 do Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	A mensagem deste erro.
target	string	O local onde o erro aconteceu, se disponível.

ErrorCode

Código de erro

Name	Tipo	Description
conflict	string	A operação solicitada entra 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. Por favor, 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 dos dados jsonl.
notFound	string	O recurso não foi encontrado.
quotaExceeded	string	Quota excedida.
serviceUnavailable	string	O serviço não está disponível no momento.
tooManyRequests	string	Demasiados pedidos. 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

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

FineTuningState

Name	Tipo	Description
cancelled	string	A operação foi cancelada e está incompleta. Pode ser categorizado como um estado terminal.
created	string	A operação foi criada. Esse estado não é retornado pelo Azure OpenAI e exposto apenas para compatibilidade. 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. Pode ser categorizado como um estado terminal.
pending	string	A operação ainda não está na fila para ser processada no futuro. Pode ser categorizado como um estado inativo.
running	string	A operação já começou a ser processada. Pode ser categorizado como um estado ativo.
succeeded	string	A operação foi processada com sucesso e está pronta para consumo. Pode ser categorizado como um estado terminal.

InnerError

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

InnerErrorCode

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

LifeCycleStatus

Status do Ciclo de Vida

Name	Tipo	Description
generally-available	string	O modelo está geralmente disponível.
preview	string	O modelo está em pré-visualização e coberto pelos termos de pré-visualização do serviço.

Model

Modelo

Name	Tipo	Description
capabilities	Capabilities	Capacidades As capacidades de um modelo base ou de ajuste fino.
created_at	integer	Um carimbo de data/hora quando este trabalho ou item foi criado (em épocas unix).
deprecation	Deprecation	Preterição Define as datas de substituição para os diferentes casos de uso de um modelo. Normalmente, os modelos base suportam 1 ano de ajuste fino após a criação. A inferência é normalmente suportada 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	Status do Ciclo de Vida O status do ciclo de vida de um modelo. Nota: Um modelo pode ser promovido de "pré-visualização" para "geralmente disponível", mas nunca de "geralmente disponível" para "pré-visualização".
model	string	A identidade do modelo base (model-id) se este for um modelo de ajuste fino; caso contrário, `null`.
object	TypeDiscriminator	TipoDiscriminador Define o tipo de um objeto.
status	FineTuningState	FineTuningState O estado de um objeto finetunes ou trabalho de ajuste fino.

ModelList

Lista de modelos

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

TypeDiscriminator

TipoDiscriminador

Name	Tipo	Description
batch	string	Este objeto representa um lote.
file	string	Este objeto representa um arquivo.
fine_tuning.job	string	Este objeto representa um trabalho de ajuste fino.
fine_tuning.job.checkpoint	string	Este objeto representa um ponto de verificação de um trabalho de ajuste fino.
fine_tuning.job.event	string	Este objeto representa um evento de um trabalho de ajuste fino.
list	string	Este objeto representa uma lista de outros objetos.
model	string	Este objeto representa um modelo (pode ser um modelo base ou um resultado de trabalho de ajuste fino).
upload	string	Este objeto representa um upload de arquivo.
upload.part	string	Este objeto representa parte de um upload de arquivo.

Partilhar via