Referência da API REST de imagem e áudio Azure OpenAI (2024-10-21)

Este artigo documenta as operações REST API de geração de imagens e inferência do plano de dados de áudio (voz) para Azure OpenAI na 2024-10-21 versão GA. Para conclusãos de chat, embeddings, completions e todas as outras operações, consulte a referência oficial da API REST do Azure OpenAI.

Especificações da API

A gestão e interação com modelos e recursos OpenAI do Azure está dividida em três superfícies principais de API:

• Plano de controlo
• Plano de dados - autoria
• Plano de dados - inferência

Cada superfície/especificação API encapsula um conjunto diferente de capacidades do Azure OpenAI. Cada API tem o seu próprio conjunto único de pré-visualização e versões de APIs estáveis/geralmente disponíveis (GA). Atualmente, os lançamentos de pré-visualização tendem a seguir uma cadência mensal.

Authentication

O Azure OpenAI fornece dois métodos para autenticação. Pode usar API Keys ou Microsoft Entra ID.

• Autenticação de Chave API: Para este tipo de autenticação, todos os pedidos de API devem incluir a Chave API no api-key cabeçalho HTTP. O Quickstart fornece orientações sobre como fazer chamadas com este tipo de autenticação.

• Microsoft Entra ID: Pode autenticar uma chamada API usando um token Microsoft Entra. Os tokens de autenticação são incluídos num pedido como Authorization cabeçalho. O token fornecido deve ser precedido por Bearer, por exemplo Bearer YOUR_AUTH_TOKEN. Pode ler o nosso guia prático sobre autenticação com Microsoft Entra ID.

Versionamento da API REST

As APIs dos serviços 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 do plano de dados

O restante deste artigo aborda as operações de imagem e áudio na versão GA da especificação de inferência do plano de dados do Azure OpenAI, 2024-10-21.

Para as operações de imagem de pré-visualização e áudio, consulte a referência da API REST de imagem de pré-visualização e áudio.

Transcrições - Criar

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Transcreve o áudio para a língua de entrada.

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Respostas

Código de Estado: 200

Descrição: OK

Exemplos

Exemplo

Obtém texto transcrito e metadados associados a partir dos dados de áudio falado fornecidos.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Respostas: Código de Estado: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Exemplo

Obtém texto transcrito e metadados associados a partir dos dados de áudio falado fornecidos.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---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 Estado: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Traduções - Create

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Transcreve e traduz áudio de entrada para texto em inglês.

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Respostas

Código de Estado: 200

Descrição: OK

Exemplos

Exemplo

Obtém texto transcrito em inglês e metadados associados a partir dos dados de áudio falado fornecidos.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---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 Estado: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Exemplo

Obtém texto transcrito em inglês e metadados associados a partir dos dados de áudio falado fornecidos.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---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 Estado: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Geração de imagens

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Gera um lote de imagens a partir de uma legenda de texto numa dada implementação do modelo dall-e

Parâmetros de URI

Cabeçalho da solicitação

Órgão do Pedido

Tipo de conteúdo: application/json

Respostas

Código de Estado: 200

Descrição: Ok

Código de Estado: padrão

Descrição: Ocorreu um erro.

Exemplos

Exemplo

Cria imagens com um prompt.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Respostas: Código de Estado: 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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Components

Para as definições de esquema usadas por chat, completions, embeddings e outras operações de texto, consulte a referência à API REST do Azure OpenAI. Os seguintes esquemas suportam as operações de imagem e áudio nesta página.

innerErrorCode

Códigos de erro para o objeto de erro interno.

Descrição: Códigos de erro para o objeto de erro interno.

Tipo: string

Predefinido:

Nome Enum: InnerErrorCode

Valores de Enum:

dalleErrorResponse

dalleError

dalleInnerError

Erro interno com detalhes adicionais.

resultadoDeSeveridadeDoFiltroDeConteúdo

resultado de deteção de filtro de conteúdo

dalleFilterResults

Informação sobre a categoria de filtragem de conteúdos (ódio, sexual, violência, self_harm), se foi detetada, bem como o nível de gravidade (escala very_low, baixa, média, alta que determina a intensidade e o nível de risco do conteúdo nocivo) e se foi filtrada ou não. Informação sobre conteúdos de jailbreak e palavrões, se foram detetados e se foram filtrados ou não. E informações sobre a lista de clientes bloqueados, se foi filtrada e o seu identificação.

Resposta de Áudio

Resposta de tradução ou transcrição quando response_format era json

audioVerboseResponse

Resposta de tradução ou transcrição quando response_format foi verbose_json

audioResponseFormat

Define o formato da saída.

Descrição: Define o formato da saída.

Tipo: string

Predefinido:

Valores de Enum:

• json
• enviar SMS
• SRT
• json verboso
• VTT

qualidade de imagem

A qualidade da imagem que será gerada.

Descrição: A qualidade da imagem que será gerada.

Tipo: string

Padrão: norma

Nome Enum: Quality

Valores de Enum:

imagesResponseFormat

O formato em que as imagens geradas são devolvidas.

Descrição: O formato em que as imagens geradas são devolvidas.

Tipo: string

Padrão: url

Nome Enum: ImagesResponseFormat

Valores de Enum:

imageSize

O tamanho das imagens geradas.

Descrição: O tamanho das imagens geradas.

Tipo: string

Padrão: 1024x1024

Nome Enum: Tamanho

Valores de Enum:

imageStyle

O estilo das imagens geradas.

Descrição: O estilo das imagens geradas.

Tipo: string

Padrão: vívido

Nome Enum: Style

Valores de Enum:

generateImagesResponse

Passos seguintes

Aprenda sobre modelos e ajuste fino com a API REST. Saiba mais sobre os modelos subjacentes que alimentam Azure OpenAI.