Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Versão API: v1
Server:{endpoint}/openai/v1 — APIs
Azure AI Foundry Models
Variáveis do Servidor:
| Variable | Predefinição | Description |
|---|---|---|
| ponto final | Um endpoint suportado para APIs do
Azure AI Foundry Models, incluindo protocolo e nome de host. Por exemplo: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/). |
Authentication
ApiKeyAuth (Chave API)
Passa a tua chave API no api-key cabeçalho.
ApiKeyAuth_ (Chave API)
Passa a tua chave 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
Alcances:
https://cognitiveservices.azure.com/.default
Requisitos de segurança
Os endpoints aceitam qualquer um dos seguintes métodos de autenticação:
- ApiKeyAuth
- ApiKeyAuth_
-
OAuth2Auth (telescópio:
https://cognitiveservices.azure.com/.default)
Listar modelos
GET {endpoint}/openai/v1/models
Lista os modelos atualmente disponíveis e fornece informações básicas sobre cada um, como o proprietário e a disponibilidade.
Parâmetros de URI
| Name | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
| ponto final | servidor | Sim | cadeia (de caracteres) | Um endpoint suportado para APIs do
Azure AI Foundry 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 (de caracteres) Valores possíveis: v1, preview |
A versão explícita da API do
Azure AI Foundry Models a ser usada para essa solicitação.v1 se não especificado de outra forma. |
Responses
Código de status: 200
Descrição: O pedido foi bem-sucedido.
| Tipo de conteúdo | Type | Description |
|---|---|---|
| application/json | OpenAI.ListModelsResponse |
Cabeçalhos de Resposta:
| Header | Tipo | Description |
|---|---|---|
| APIM-Request-ID | cadeia (de caracteres) | Um ID de pedido usado para fins de resolução de problemas. |
Código de status: padrão
Descrição: Uma resposta de erro inesperada.
| Tipo de conteúdo | Type | Description |
|---|---|---|
| application/json | objecto |
| Name | Tipo | Description | Obrigatório | Predefinição |
|---|---|---|---|---|
| código | string ou null | Sim | ||
| inner_error | No | |||
| mensagem | cadeia (de caracteres) | Sim | ||
| param | string ou null | No | ||
| tipo | cadeia (de caracteres) | No |
Cabeçalhos de Resposta:
| Header | Tipo | Description |
|---|---|---|
| APIM-Request-ID | cadeia (de caracteres) | Um ID de pedido usado para fins de resolução de problemas. |
Recuperar modelo
GET {endpoint}/openai/v1/models/{model}
Recupera uma instância do modelo, fornecendo informações básicas sobre o modelo, como o proprietário e a permissão.
Parâmetros de URI
| Name | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
| ponto final | servidor | Sim | cadeia (de caracteres) | Um endpoint suportado para APIs do
Azure AI Foundry 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 (de caracteres) Valores possíveis: v1, preview |
A versão explícita da API do
Azure AI Foundry Models a ser usada para essa solicitação.v1 se não especificado de outra forma. |
| modelo | caminho | Sim | cadeia (de caracteres) | A ID do modelo a ser usado para essa solicitação. |
Responses
Código de status: 200
Descrição: O pedido foi bem-sucedido.
| Tipo de conteúdo | Type | Description |
|---|---|---|
| application/json | OpenAI.Model |
Cabeçalhos de Resposta:
| Header | Tipo | Description |
|---|---|---|
| APIM-Request-ID | cadeia (de caracteres) | Um ID de pedido usado para fins de resolução de problemas. |
Código de status: padrão
Descrição: Uma resposta de erro inesperada.
| Tipo de conteúdo | Type | Description |
|---|---|---|
| application/json | objecto |
| Name | Tipo | Description | Obrigatório | Predefinição |
|---|---|---|---|---|
| código | string ou null | Sim | ||
| inner_error | No | |||
| mensagem | cadeia (de caracteres) | Sim | ||
| param | string ou null | No | ||
| tipo | cadeia (de caracteres) | No |
Cabeçalhos de Resposta:
| Header | Tipo | Description |
|---|---|---|
| APIM-Request-ID | cadeia (de caracteres) | Um ID de pedido usado para fins de resolução de problemas. |
Excluir modelo
DELETE {endpoint}/openai/v1/models/{model}
Apaga uma instância de modelo.
Parâmetros de URI
| Name | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
| ponto final | servidor | Sim | cadeia (de caracteres) | Um endpoint suportado para APIs do
Azure AI Foundry 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 (de caracteres) Valores possíveis: v1, preview |
A versão explícita da API do
Azure AI Foundry Models a ser usada para essa solicitação.v1 se não especificado de outra forma. |
| modelo | caminho | Sim | cadeia (de caracteres) | O ID do modelo a apagar. |
Responses
Código de status: 200
Descrição: O pedido foi bem-sucedido.
| Tipo de conteúdo | Type | Description |
|---|---|---|
| application/json | OpenAI.DeleteModelResponse |
Cabeçalhos de Resposta:
| Header | Tipo | Description |
|---|---|---|
| APIM-Request-ID | cadeia (de caracteres) | Um ID de pedido usado para fins de resolução de problemas. |
Código de status: padrão
Descrição: Uma resposta de erro inesperada.
| Tipo de conteúdo | Type | Description |
|---|---|---|
| application/json | objecto |
| Name | Tipo | Description | Obrigatório | Predefinição |
|---|---|---|---|---|
| código | string ou null | Sim | ||
| inner_error | No | |||
| mensagem | cadeia (de caracteres) | Sim | ||
| param | string ou null | No | ||
| tipo | cadeia (de caracteres) | No |
Cabeçalhos de Resposta:
| Header | Tipo | Description |
|---|---|---|
| APIM-Request-ID | cadeia (de caracteres) | Um ID de pedido usado para fins de resolução de problemas. |
Components
AzureAIFoundryModelsApiVersion
| Property | Valor |
|---|---|
| Type | cadeia (de caracteres) |
| Valores | v1preview |
OpenAI.DeleteModelResponse
| Name | Tipo | Description | Obrigatório | Predefinição |
|---|---|---|---|---|
| Suprimido | boolean | Sim | ||
| id | cadeia (de caracteres) | Sim | ||
| objecto | cadeia (de caracteres) | Sim |
OpenAI.ListModelsResponse
| Name | Tipo | Description | Obrigatório | Predefinição |
|---|---|---|---|---|
| dados | array do OpenAI.Model | Sim | ||
| objecto | enumeração | Valores possíveis: list |
Sim |
OpenAI.Model
Modelo
Descreve uma oferta de modelo OpenAI que pode ser usada com a API.
| Name | Tipo | Description | Obrigatório | Predefinição |
|---|---|---|---|---|
| criado | inteiro (unixtime) | O carimbo de data/hora Unix (em segundos) quando o modelo foi criado. | Sim | |
| id | cadeia (de caracteres) | O identificador de modelo, que pode ser referenciado nos endpoints da API. | Sim | |
| objecto | enumeração | O tipo de objeto, que é sempre "modelo". Valores possíveis: model |
Sim | |
| pertencente_a | cadeia (de caracteres) | A organização proprietária do modelo. | Sim |