Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Este artigo documenta a geração de imagem e as operações da API REST de inferência do plano de dados de áudio (fala) para Azure OpenAI na 2025-04-01-preview versão. Para conclusões de chat, inserções, assistentes, respostas, repositórios de vetores e todas as outras operações, consulte a referência oficial da API REST do Azure OpenAI.
Especificações de API
Gerenciar e interagir com modelos e recursos do OpenAI do Azure é dividido em três superfícies principais de API:
- Painel de controle
- Plano de dados - autoria
- Plano de dados - inferência
Cada superfície/especificação de API encapsula um conjunto diferente de capacidades do Azure OpenAI. Cada API possui seu próprio conjunto único de pré-visualizações e versões estáveis/geralmente disponíveis (GA). Os lançamentos de prévia atualmente tendem a seguir uma cadência mensal.
Importante
Agora há uma nova API de inferência de pré-visualização. Saiba mais em nosso guia do ciclo de vida da API.
| API | Última versão de prévia | Última versão da GA | Specifications | Descrição |
|---|---|---|---|---|
| Plano de controle | 2025-07-01-preview |
2025-06-01 |
Arquivos de especificação | A API do plano de controle é usada para operações como criação de recursos, implantação de modelos e outras tarefas de gerenciamento de recursos de nível superior. O plano de controle também governa o que é possível fazer com capacidades como Azure Resource Manager, Bicep, Terraform e CLI do Azure. |
| Plano de dados | v1 preview |
v1 |
Arquivos de especificação | A API do plano de dados controla as operações de inferência e autoria. |
Autenticação
O Azure OpenAI oferece dois métodos para autenticação. Você pode usar tanto API Keys quanto Microsoft Entra ID.
Autenticação de Chave API: Para esse tipo de autenticação, todas as requisições de API devem incluir a Chave API no
api-keycabeçalho HTTP. O Quickstart fornece orientações sobre como fazer chamadas com esse tipo de autenticação.Microsoft Entra ID: Você pode autenticar uma chamada API usando um token Microsoft Entra. Tokens de autenticação são incluídos em uma solicitação como cabeçalho Authorization. O token fornecido deve ser precedido porBearer, por exemploBearer YOUR_AUTH_TOKEN. Você pode ler nosso guia prático sobre autenticação com Microsoft Entra ID.
Versionamento da API REST
As APIs de serviço são versionadas usando o api-version parâmetro de consulta. Todas as versões seguem a estrutura de datas YYYY-MM-DD. Por exemplo:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Inferência de plano de dados
O restante deste artigo aborda as operações de imagem e áudio na 2025-04-01-preview versão prévia da especificação de inferência do plano de dados Azure OpenAI.
Para as operações de áudio e imagem GA, consulte a referência da API REST de áudio e imagem GA.
Transcrições - Criar
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Transcreve o áudio para a língua de entrada.
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| ponto de extremidade | caminho | Yes | URL da sequência de caracteres | Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | caminho | Yes | cadeia | |
| versão da API | consulta | Yes | cadeia |
Cabeçalho da solicitação
Use autenticação baseada em token ou chave API. A autenticação com autenticação baseada em token é recomendada e mais segura.
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Autorização | Verdade | cadeia |
Exemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token}Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeESCOPO: https://ai.azure.com/.default |
| chave da API | Verdade | cadeia | Forneça a chave API do Azure OpenAI aqui |
Corpo da solicitação
Content-Type: multipart/form-data (dados de formulário em múltiplas partes)
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| modelo | cadeia | ID do modelo a ser usado. As opções são gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1, e gpt-4o-transcribe-diarize. |
Yes | |
| arquivo | cadeia | O arquivo de áudio é objeto para transcrever. | Yes | |
| linguagem | cadeia | O idioma do áudio de entrada. Fornecer a linguagem de entrada no formato ISO-639-1 melhora a precisão e a latência. | No | |
| solicitação | cadeia | Um texto opcional para guiar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve corresponder à linguagem do áudio. | No | |
| formato_de_resposta | audioResponseFormat | Define o formato da saída. | No | |
| Temperatura | number | A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornam mais focada e determinística. Se definido como 0, o modelo usa a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos. | No | 0 |
| timestamp_granularities[] | matriz | As granularidades do timestamp devem preencher para essa transcrição.
response_format deve ser configurado verbose_json para usar granularidades de carimbo de tempo. Uma ou ambas essas opções são suportadas: word, ou segment. Nota: Não há latência adicional para carimbos de tempo de segmentos, mas gerar carimbos de data de tempo de palavra gera latência adicional. |
No | ['segment'] |
Respostas
Código de status: 200
Descrição: OK
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/json | objeto | |
| texto/sem formatação | cadeia | Texto transcrito no formato de saída (quando response_format era um dos text, vtt ou srt). |
Exemplos
Example
Recebe texto transcrito e metadados associados a partir dos dados de áudio falados fornecidos.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
Respostas: Código de status: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Example
Recebe texto transcrito e metadados associados a partir dos dados de áudio falados fornecidos.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Respostas: Código de status: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Traduções - Criar
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
Transcreve e traduz áudio de entrada para texto em inglês.
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| ponto de extremidade | caminho | Yes | URL da sequência de caracteres | Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | caminho | Yes | cadeia | |
| versão da API | consulta | Yes | cadeia |
Cabeçalho da solicitação
Use autenticação baseada em token ou chave API. A autenticação com autenticação baseada em token é recomendada e mais segura.
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Autorização | Verdade | cadeia |
Exemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token}Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeESCOPO: https://ai.azure.com/.default |
| chave da API | Verdade | cadeia | Forneça a chave API do Azure OpenAI aqui |
Corpo da solicitação
Content-Type: multipart/form-data (dados de formulário em múltiplas partes)
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| arquivo | cadeia | O arquivo de áudio para traduzir. | Yes | |
| solicitação | cadeia | Um texto opcional para guiar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve estar em inglês. | No | |
| formato_de_resposta | audioResponseFormat | Define o formato da saída. | No | |
| Temperatura | number | A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornam mais focada e determinística. Se definido como 0, o modelo usa a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos. | No | 0 |
Respostas
Código de status: 200
Descrição: OK
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/json | objeto | |
| texto/sem formatação | cadeia | Texto transcrito no formato de saída (quando response_format era de texto, vtt ou srt). |
Exemplos
Example
Obtém texto transcrito em inglês e metadados associados a partir dos dados de áudio falados fornecidos.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Respostas: Código de status: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Example
Obtém texto transcrito em inglês e metadados associados a partir dos dados de áudio falados fornecidos.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Respostas: Código de status: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Fala - Criar
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview
Gera áudio a partir do texto de entrada.
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| ponto de extremidade | caminho | Yes | URL da sequência de caracteres | Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | caminho | Yes | cadeia | |
| versão da API | consulta | Yes | cadeia |
Cabeçalho da solicitação
Use autenticação baseada em token ou chave API. A autenticação com autenticação baseada em token é recomendada e mais segura.
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Autorização | Verdade | cadeia |
Exemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token}Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeESCOPO: https://ai.azure.com/.default |
| chave da API | Verdade | cadeia | Forneça a chave API do Azure OpenAI aqui |
Corpo da solicitação
Content-Type: multipart/form-data (dados de formulário em múltiplas partes)
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| entrada | cadeia | O texto para sintetizar áudio. O comprimento máximo é de 4.096 caracteres. | Yes | |
| formato_de_resposta | enumeração | O formato para sintetizar o áudio. Valores possíveis: mp3, opus, aac, flac, wav, pcm |
No | |
| Velocidade | number | A velocidade do áudio sintetizado. Selecione um valor de 0.25 para 4.0.
1.0 é o padrão. |
No | 1.0 |
| Voz | enumeração | A voz para usar na síntese de voz. Valores possíveis: alloy, echo, fable, onyx, nova, shimmer |
Yes |
Respostas
Código de status: 200
Descrição: OK
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/octet-stream | cadeia |
Exemplos
Example
Sintetiza o áudio a partir do texto fornecido.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview
{
"input": "Hi! What are you going to make?",
"voice": "fable",
"response_format": "mp3"
}
Respostas: Código de status: 200
{
"body": "101010101"
}
Gerações de imagens - Criar
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview
Gera um lote de imagens a partir de uma legenda de texto em uma determinada implantação de modelo de geração de imagem
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| ponto de extremidade | caminho | Yes | URL da sequência de caracteres | Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | caminho | Yes | cadeia | |
| versão da API | consulta | Yes | cadeia |
Cabeçalho da solicitação
Use autenticação baseada em token ou chave API. A autenticação com autenticação baseada em token é recomendada e mais segura.
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Autorização | Verdade | cadeia |
Exemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token}Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeESCOPO: https://ai.azure.com/.default |
| chave da API | Verdade | cadeia | Forneça a chave API do Azure OpenAI aqui |
Corpo da solicitação
Tipo de conteúdo: application/json
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| em segundo plano | imageBackground | Permite definir transparência para o fundo das imagens geradas. Esse parâmetro é suportado apenas para modelos da série gpt-imagem-1. | No | automático |
| n | inteiro | O número de imagens a serem geradas. Para dall-e-3, apenas n=1 é suportado. | No | 1 |
| compressão_de_saída | inteiro | O nível de compressão (0-100%) para as imagens geradas. Esse parâmetro é suportado apenas para modelos da série gpt-image-1 com o formato de saída jpeg. | No | 100 |
| formato de saída | imagesOutputFormat | O formato de arquivo no qual as imagens geradas são retornadas. Suportado apenas para modelos da série GPT-image-1. | No | png |
| solicitação | cadeia | Uma descrição em texto da(s) imagem(s) desejada(s). O comprimento máximo é de 32.000 caracteres para a série gpt-image-1 e 4.000 caracteres para dall-e-3 | Yes | |
| imagens parciais | inteiro | O número de imagens parciais a serem geradas. Esse parâmetro é usado para respostas em streaming que retornam imagens parciais. O valor deve estar entre 0 e 3. Quando configurado para 0, a resposta será uma única imagem enviada em um evento de streaming. Note que a imagem final pode ser enviada antes que o número total de imagens parciais seja gerado se a imagem completa for gerada mais rapidamente. | 0 | |
| fluxo | booleano | Edite a imagem no modo streaming. | não | false |
| Qualidade | imageQuality | A qualidade da imagem que será gerada. | No | automático |
| formato_de_resposta | imagesResponseFormat | O formato no qual as imagens geradas são retornadas. Esse parâmetro não é suportado para gpt-image-1modelos da série -que sempre retornam imagens codificadas base64.Valores possíveis: url, b64_json. |
No | url |
| size | imageSize | O tamanho das imagens geradas. | No | automático |
| estilo | imageStyle | O estilo das imagens geradas. Só é suportado para DALL-E-3. | No | Vívido |
| usuário | cadeia | Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos. | No |
Respostas
Código de status: 200
Descrição: Ok
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/json | generateImagesResponse |
Código de status: padrão
Descrição: Ocorreu um erro.
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/json | dalleErrorResponse |
Exemplos
Example
Cria imagens com um prompt.
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview
{
"prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
"n": 1,
"style": "natural",
"quality": "standard"
}
Respostas: Código de status: 200
{
"body": {
"created": 1698342300,
"data": [
{
"revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
"prompt_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
},
"profanity": {
"detected": false,
"filtered": false
},
"custom_blocklists": {
"filtered": false,
"details": []
}
},
"url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
"content_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
}
}
}
]
}
}
Gerações de imagens - Editar
POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview
Edita uma imagem a partir de uma legenda de texto em uma determinada implantação de modelo gpt-image-1
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
| ponto de extremidade | caminho | Yes | URL da sequência de caracteres | Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com |
| deployment-id | caminho | Yes | cadeia | |
| versão da API | consulta | Yes | cadeia |
Cabeçalho da solicitação
Use autenticação baseada em token ou chave API. A autenticação com autenticação baseada em token é recomendada e mais segura.
| Nome | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| Autorização | Verdade | cadeia |
Exemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token}Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.comTipo: oauth2 URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorizeESCOPO: https://ai.azure.com/.default |
| chave da API | Verdade | cadeia | Forneça a chave API do Azure OpenAI aqui |
Corpo da solicitação
Content-Type: multipart/form-data (dados de formulário em múltiplas partes)
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| imagem | String ou array | A(s) imagem(ões) a editar. Deve ser um arquivo de imagem suportado ou um array de imagens. Cada imagem deve ser um arquivo png ou jpg com menos de 50MB. | Yes | |
| fidelidade_de_entrada | cadeia | Controle quanto esforço o modelo fará para combinar com o estilo e as características, especialmente as características faciais, das imagens de entrada. Esse parâmetro é suportado apenas para modelos da série gpt-imagem-1. Suportes high e low. |
não |
low. |
| máscara | cadeia | Uma imagem adicional cujas áreas totalmente transparentes (por exemplo, onde alfa é zero) indica onde a imagem deve ser editada. Se houver várias imagens fornecidas, a máscara será aplicada à primeira imagem. Deve ser um arquivo PNG válido, com menos de 4MB, e ter as mesmas dimensões da imagem. | No | |
| n | inteiro | O número de imagens a serem geradas. Deve estar entre 1 e 10. | No | 1 |
| solicitação | cadeia | Uma descrição em texto da(s) imagem(s) desejada(s). O comprimento máximo é de 32.000 caracteres. | Yes | |
| Qualidade | imageQuality | A qualidade da imagem que será gerada. | No | automático |
| imagens parciais | O número de imagens parciais a serem geradas. Esse parâmetro é usado para respostas em streaming que retornam imagens parciais. O valor deve estar entre 0 e 3. Quando configurado para 0, a resposta será uma única imagem enviada em um evento de streaming. Note que a imagem final pode ser enviada antes que o número total de imagens parciais seja gerado se a imagem completa for gerada mais rapidamente. | |||
| fluxo | booleano | Edite a imagem no modo streaming. | não | false |
| formato_de_resposta | imagesResponseFormat | O formato no qual as imagens geradas são retornadas. | No | url |
| size | imageSize | O tamanho das imagens geradas. | No | automático |
| usuário | cadeia | Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos. | No |
Respostas
Código de status: 200
Descrição: Ok
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/json | generateImagesResponse |
Código de status: padrão
Descrição: Ocorreu um erro.
| Tipo de conteúdo | Tipo | Descrição |
|---|---|---|
| application/json | dalleErrorResponse |
Componentes
Para obter as definições de esquema usadas por chat, conclusões, inserções, respostas e outras operações de texto, consulte a referência da API REST do Azure OpenAI. Os esquemas a seguir dão suporte às operações de imagem e áudio nesta página.
innerErrorCode
Códigos de erro para o objeto de erro interno.
| Property | Valor |
|---|---|
| Descrição | Códigos de erro para o objeto de erro interno. |
| Tipo | cadeia |
| Valores | ResponsibleAIPolicyViolation |
dalleErrorResponse
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| erro | dalleError | No |
dalleError
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| inner_error | dalleInnerError | Erro interno com detalhes adicionais. | No | |
| param | cadeia | No | ||
| tipo | cadeia | No |
dalleInnerError
Erro interno com detalhes adicionais.
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| codificar | innerErrorCode | Códigos de erro para o objeto de erro interno. | No | |
| content_filter_results | dalleFilterResults | Informações sobre a categoria de filtragem de conteúdo (ódio, sexual, violência, self_harm), se ela foi detectada, bem como o nível de gravidade (very_low, baixo, médio, alto que determina a intensidade e o nível de risco do conteúdo nocivo) e se foi filtrado ou não. Informações sobre conteúdo de jailbreak e palavrões, se foram detectados e se foram filtrados ou não. E informações sobre a lista de bloqueio de clientes, se foi filtrada e seu ID. | No | |
| revised_prompt | cadeia | O prompt usado para gerar a imagem, caso houvesse alguma revisão no prompt. | No |
contentFilterSeverityResult
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| Filtrada | booleano | Yes | ||
| severity | cadeia | No |
contentFilterDetectedResult
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| detectado | booleano | No | ||
| Filtrada | booleano | Yes |
contentFilterDetailedResults
Resultados de filtragem de conteúdo com um detalhe dos IDs de filtro de conteúdo para os segmentos filtrados.
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| details | matriz | No | ||
| Filtrada | booleano | Yes |
dalleFilterResults
Informações sobre a categoria de filtragem de conteúdo (ódio, sexual, violência, self_harm), se ela foi detectada, bem como o nível de gravidade (very_low, baixo, médio, alto que determina a intensidade e o nível de risco do conteúdo nocivo) e se foi filtrado ou não. Informações sobre conteúdo de jailbreak e palavrões, se foram detectados e se foram filtrados ou não. E informações sobre a lista de bloqueio de clientes, se foi filtrada e seu ID.
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| custom_blocklists | contentFilterDetailedResults | Resultados de filtragem de conteúdo com um detalhe dos IDs de filtro de conteúdo para os segmentos filtrados. | No | |
| Odeio | Resultado de Severidade do Filtro de Conteúdo | No | ||
| jailbreak | Resultado de Filtro de Conteúdo Detectado | No | ||
| Profanidade | Resultado de Filtro de Conteúdo Detectado | No | ||
| self_harm | Resultado de Severidade do Filtro de Conteúdo | No | ||
| sexual | Resultado de Severidade do Filtro de Conteúdo | No | ||
| Violência | Resultado de Severidade do Filtro de Conteúdo | No |
audioResponseFormat
Define o formato da saída.
| Property | Valor |
|---|---|
| Descrição | Define o formato da saída. |
| Tipo | cadeia |
| Valores | jsontextsrtverbose_jsonvtt |
imageQuality
A qualidade da imagem que será gerada.
| Property | Valor |
|---|---|
| Descrição | A qualidade da imagem que será gerada. |
| Tipo | cadeia |
| Default | automático |
| Valores | autohighmediumlowhdstandard |
imagesResponseFormat
O formato no qual as imagens geradas são retornadas.
| Property | Valor |
|---|---|
| Descrição | O formato no qual as imagens geradas são retornadas. |
| Tipo | cadeia |
| Default | url |
| Valores | urlb64_json |
imagesOutputFormat
O formato de arquivo no qual as imagens geradas são retornadas. Só é suportado para modelos de série.
| Property | Valor |
|---|---|
| Descrição | O formato de arquivo no qual as imagens geradas são retornadas. Suportado apenas para modelos da série GPT-image-1. |
| Tipo | cadeia |
| Default | png |
| Valores | pngjpeg |
imageSize
O tamanho das imagens geradas.
| Property | Valor |
|---|---|
| Descrição | O tamanho das imagens geradas. |
| Tipo | cadeia |
| Default | automático |
| Valores | auto1792x10241024x17921024x10241024x15361536x1024 |
imageStyle
O estilo das imagens geradas. Só é suportado para DALL-E-3.
| Property | Valor |
|---|---|
| Descrição | O estilo das imagens geradas. Só é suportado para DALL-E-3. |
| Tipo | cadeia |
| Default | Vívido |
| Valores | vividnatural |
imageBackground
Permite definir a transparência para o fundo da(s) imagem(s) gerada(s). Esse parâmetro é suportado apenas para modelos da série gpt-imagem-1.
| Property | Valor |
|---|---|
| Descrição | Permite definir a transparência para o fundo da(s) imagem(s) gerada(s). Esse parâmetro é suportado apenas para modelos da série gpt-imagem-1. |
| Tipo | cadeia |
| Default | automático |
| Valores | transparentopaqueauto |
generateImagesResponse
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| criado | inteiro | O carimbo de data do unix quando a operação foi criada. | Yes | |
| dados | matriz | Os dados de resultado da operação, se bem-sucedidos | Yes | |
| uso | imageGenerationsUsage | Representa detalhes de uso de tokens para solicitações de geração de imagem. Apenas para modelos da série GPT-image-1. | No |
imageGenerationsUsage
Representa detalhes de uso de tokens para solicitações de geração de imagem. Apenas para modelos da série GPT-image-1.
| Nome | Tipo | Descrição | Obrigatório | Default |
|---|---|---|---|---|
| input_tokens | inteiro | O número de tokens de entrada. | No | |
| input_tokens_details | objeto | Uma divisão detalhada dos tokens de entrada. | No | |
| └─ image_tokens | inteiro | O número de tokens de imagem. | No | |
| └─ text_tokens | inteiro | O número de tokens de texto. | No | |
| output_tokens | inteiro | O número de tokens de saída. | No | |
| total_tokens | inteiro | O número total de tokens usados. | No |
Próximas Etapas
Saiba mais sobre modelos e ajuste fino com a API REST. Saiba mais sobre os modelos underlying que alimentam Azure OpenAI.