Modelos do Azure OpenAI

Versão da API: v1

Server:{endpoint}/openai/v1 — APIs Fábrica de IA do Azure Models

Variáveis de servidor:

Variable	Default	Description
ponto de extremidade		Um endpoint de APIs suportado pelo Fábrica de IA do Azure Models, incluindo protocolo e nome de host. Por exemplo: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).

Authentication

ApiKeyAuth (API Key)

Passe sua chave de API no api-key cabeçalho.

ApiKeyAuth_ (Chave API)

Passe sua chave de API no authorization cabeçalho.

OAuth2Auth (OAuth 2.0)

Fluxo: implícito

URL de autorização:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos:

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

Requisitos de segurança

Os endpoints aceitam qualquer um dos seguintes métodos de autenticação:

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

Listar modelos

GET {endpoint}/openai/v1/models

Lista os modelos disponíveis no momento e fornece informações básicas sobre cada um deles, como o proprietário e a disponibilidade.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure Models, incluindo protocolo e nome de host. Por exemplo: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
versão da API	consulta	No	cadeia Valores possíveis: v1, preview	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. v1 se não for especificado de outra forma.

Responses

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Type	Description
application/json	OpenAI.ListModelsResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia de caracteres ou nulo		Yes
inner_error			No
mensagem	cadeia		Yes
param	cadeia de caracteres ou nulo		No
tipo	cadeia		No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Recuperar modelo

GET {endpoint}/openai/v1/models/{model}

Recupera uma instância de modelo, fornecendo informações básicas sobre o modelo, como o proprietário e permissões.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure Models, incluindo protocolo e nome de host. Por exemplo: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
versão da API	consulta	No	cadeia Valores possíveis: v1, preview	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. v1 se não for especificado de outra forma.
modelo	caminho	Yes	cadeia	A ID do modelo a ser usado para essa solicitação.

Responses

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Type	Description
application/json	OpenAI.Model

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia de caracteres ou nulo		Yes
inner_error			No
mensagem	cadeia		Yes
param	cadeia de caracteres ou nulo		No
tipo	cadeia		No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Excluir modelo

DELETE {endpoint}/openai/v1/models/{model}

Exclui uma instância de modelo.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
ponto de extremidade	servidor	Yes	cadeia	Um endpoint de APIs suportado pelo Fábrica de IA do Azure Models, incluindo protocolo e nome de host. Por exemplo: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/).
versão da API	consulta	No	cadeia Valores possíveis: v1, preview	A versão explícita da API de Modelos do Fábrica de IA do Azure a ser usada para essa solicitação. v1 se não for especificado de outra forma.
modelo	caminho	Yes	cadeia	A ID do modelo a ser excluído.

Responses

Código de status: 200

Descrição: a solicitação foi bem-sucedida.

Tipo de conteúdo	Type	Description
application/json	OpenAI.DeleteModelResponse

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Type	Description
application/json	objeto

Nome	Tipo	Description	Obrigatório	Default
codificar	cadeia de caracteres ou nulo		Yes
inner_error			No
mensagem	cadeia		Yes
param	cadeia de caracteres ou nulo		No
tipo	cadeia		No

Cabeçalhos de resposta:

Cabeçalho	Tipo	Description
apim-request-id	cadeia	Uma ID de solicitação usada para fins de solução de problemas.

Components

AzureAIFoundryModelsApiVersion

Property	Valor
Type	cadeia
Valores	v1 preview

OpenAI.DeleteModelResponse

Nome	Tipo	Description	Obrigatório	Default
excluído	boolean		Yes
id	cadeia		Yes
objeto	cadeia		Yes

OpenAI.ListModelsResponse

Nome	Tipo	Description	Obrigatório	Default
dados	matriz de OpenAI.Model		Yes
objeto	enumeração	Valores possíveis: list	Yes

OpenAI.Model

Modelo

Descreve uma oferta de modelo openai que pode ser usada com a API.

Nome	Tipo	Description	Obrigatório	Default
criado	inteiro (unixtime)	O carimbo de data/hora unix (em segundos) quando o modelo foi criado.	Yes
id	cadeia	O identificador de modelo, que pode ser referenciado nos pontos de extremidade da API.	Yes
objeto	enumeração	O tipo de objeto, que é sempre "model". Valores possíveis: model	Yes
owned_by	cadeia	A organização que possui o modelo.	Yes