Azure OpenAI em Microsoft Foundry Models REST API referência

Este artigo fornece detalhes sobre os endpoints de inferência da API REST para 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-key cabeç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 por Bearer, por exemplo Bearer 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 do artigo aborda a versão geral da especificação de inferência de planos de dados da OpenAI Azure 2024-10-21.

Se você estiver procurando documentação sobre a versão mais recente da API de visualização, consulte a API de inferência do plano de dados de versão prévia mais recente.

Conclusões

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

Cria uma conclusão para o prompt fornecido, parâmetros e modelo escolhido.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	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	ID de implantação do modelo que foi implantado.
versão da API	consulta	Yes	cadeia	Versão da API

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Descrição
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
solicitação	String ou array	O(s) prompt(s) para gerar completações para codificados como uma string, array de strings, array de tokens ou array de tokens. Note que <\|endoftext\|> é o separador de documentos que o modelo vê durante o treinamento, então, se um prompt não for especificado, o modelo será gerado como se fosse do início de um novo documento.	Yes
melhor_de	inteiro	Gera `best_of` conclusãos do lado do servidor e retorna o "melhor" (aquele com maior probabilidade logaritária por token). Os resultados não podem ser transmitidos em streaming. Quando usado com `n`, `best_of` controla o número de conclusãos candidatas e `n` especifica quantas devolver â€" `best_of` deve ser maior que `n`. Nota: Como esse parâmetro gera muitas conclusãos, ele pode rapidamente consumir sua cota de tokens. Use com cuidado e certifique-se de que você tenha configurações razoáveis para `max_tokens` e `stop`.	No	1
echo	booleano	Repita o prompt além da conclusão	No	Falso
frequency_penalty	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na frequência existente no texto até então, diminuindo a probabilidade do modelo repetir a mesma frase literalmente.	No	0
logit_bias	objeto	Modificar a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto JSON que mapeia tokens (especificados pelo ID do token no tokenizador GPT) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará de modelo para modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar em banimento ou seleção exclusiva do token relevante. Por exemplo, você pode passar `{"50256": -100}` para impedir que o <token \|endoftext\|> seja gerado.	No	Nenhum
logprobs	inteiro	Inclua as probabilidades logarítmicas dos `logprobs` tokens de saída mais prováveis, assim como os tokens escolhidos. Por exemplo, se `logprobs` for 5, a API retornará uma lista dos cinco tokens mais prováveis. A API sempre retornará o `logprob` do token amostrado, então pode haver até até `logprobs+1` elementos na resposta. O valor máximo para `logprobs` é 5.	No	Nenhum
número máximo de tokens	inteiro	O número máximo de tokens que podem ser gerados na conclusão. A contagem de tokens do seu prompt plus `max_tokens` não pode exceder o comprimento de contexto do modelo.	No	16
n	inteiro	Quantas conclusãos gerar para cada prompt. Nota: Como esse parâmetro gera muitas conclusãos, ele pode rapidamente consumir sua cota de tokens. Use com cuidado e certifique-se de que você tenha configurações razoáveis para `max_tokens` e `stop`.	No	1
penalidade_de_presença	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua aparição no texto até então, aumentando a probabilidade do modelo de falar sobre novos temas.	No	0
seed	inteiro	Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que requisições repetidas com os mesmos `seed` parâmetros retornem o mesmo resultado. Determinismo não é garantido, e você deve consultar o `system_fingerprint` parâmetro de resposta para monitorar mudanças no backend.	No
Parar	String ou array	Até quatro sequências em que a API para de gerar mais tokens. O texto devolvido não vai conter a sequência de paradas.	No
fluxo	booleano	Se deveria recuar o progresso parcial. Se ativados, os tokens serão enviados apenas como eventos enviados pelo servidor apenas por dados assim que estiverem disponíveis, com o fluxo encerrado por uma `data: [DONE]` mensagem.	No	Falso
Sufixo	cadeia	O sufixo que vem após a conclusão do texto inserido. Esse parâmetro é suportado apenas para `gpt-3.5-turbo-instruct`.	No	Nenhum
Temperatura	number	Qual temperatura de amostragem usar, entre 0 e 2. 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. Geralmente recomendamos alterar isso ou `top_p` , mas não ambos.	No	1
top_p	number	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem a massa de probabilidade de 10 maiores% são considerados. Geralmente recomendamos alterar isso ou `temperature` , mas não ambos.	No	1
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	createCompletionResponse	Representa uma resposta de conclusão da API. Nota: tanto os objetos de resposta transmitidos quanto os não transmitidos compartilham a mesma forma (diferente do endpoint do chat).

Código de status: padrão

Descrição: Serviço indisponível

Tipo de conteúdo	Tipo	Descrição
application/json	errorResponse

Exemplos

Example

Cria uma conclusão para o prompt fornecido, parâmetros e modelo escolhido.

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Respostas: Código de status: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Embeddings

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

Obtenha uma representação vetorial de uma entrada dada que possa ser facilmente consumida por modelos e algoritmos de aprendizado de máquina.

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	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	Versão da API

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Descrição
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
entrada	String ou array	Input texto para incorporar, codificado como uma string ou array de tokens. Para incorporar múltiplas entradas em uma única requisição, passe um array de strings ou array de tokens. A entrada não deve exceder o máximo de tokens de entrada para o modelo (8.192 tokens para `text-embedding-ada-002`), não pode ser uma string vazia, e qualquer array deve ter 2.048 dimensões ou menos. Além do limite de token por entrada, todos os modelos de inserção impõem um máximo de 300.000 tokens somados em todas as entradas em uma única solicitação.	Yes
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos.	No
tipo_de_entrada	cadeia	Tipo de entrada de busca de embedding a usar	No
encoding_format	cadeia	O formato para retornar os embeddings. Pode ser qualquer um ou `floatbase64`outro. O padrão é .`float`	No
dimensões	inteiro	O número de dimensões que os embeddings de saída resultantes devem ter. Só suportado em `text-embedding-3` modelos e modelos posteriores.	No

Respostas

Nome	Tipo	Obrigatório
objeto	cadeia	Yes
modelo	cadeia	Yes
dados	matriz	Yes
uso	objeto	Yes

Propriedades para uso

prompt_tokens

Nome	Tipo	Descrição	Default
prompt_tokens	inteiro

total_tokens

Nome	Tipo	Descrição	Default
total_tokens	inteiro

Código de status: 200

Descrição: OK

Tipo de conteúdo	Tipo	Descrição
application/json	objeto

Exemplos

Example

Devolva os embeddings para um determinado prompt.

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

{
 "input": [
  "this is a test"
 ]
}

Respostas: Código de status: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Finalizações de chat

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

Cria uma conclusão para a mensagem do chat

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	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	ID de implantação do modelo que foi implantado.
versão da API	consulta	Yes	cadeia	Versão da API

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Descrição
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
Temperatura	number	Qual temperatura de amostragem usar, entre 0 e 2. 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. Geralmente recomendamos alterar isso ou `top_p` , mas não ambos.	No	1
top_p	number	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem a massa de probabilidade de 10 maiores% são considerados. Geralmente recomendamos alterar isso ou `temperature` , mas não ambos.	No	1
fluxo	booleano	Se ativado, serão enviados deltas parciais de mensagens, como no ChatGPT. Os tokens serão enviados apenas como eventos enviados pelo servidor apenas com dados assim que estiverem disponíveis, com o fluxo encerrado por uma `data: [DONE]` mensagem.	No	Falso
Parar	String ou array	Até quatro sequências em que a API para de gerar mais tokens.	No
número máximo de tokens	inteiro	O número máximo de tokens que podem ser gerados na conclusão do chat. O comprimento total dos tokens de entrada e dos tokens gerados é limitado pelo comprimento do contexto do modelo.	No
max_completion_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma conclusão, incluindo tokens de saída visíveis e tokens de raciocínio.	No
penalidade_de_presença	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua aparição no texto até então, aumentando a probabilidade do modelo de falar sobre novos temas.	No	0
frequency_penalty	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na frequência existente no texto até então, diminuindo a probabilidade do modelo repetir a mesma frase literalmente.	No	0
logit_bias	objeto	Modificar a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto JSON que mapeia tokens (especificados pelo ID do token no tokenizador) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará de modelo para modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar em banimento ou seleção exclusiva do token relevante.	No	Nenhum
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos.	No
Mensagens	matriz	Uma lista de mensagens que compõem a conversa até agora.	Yes
data_sources	matriz	As entradas de configuração para as extensões de chat do Azure OpenAI que as utilizam. Essa especificação adicional é compatível apenas com o Azure OpenAI.	No
logprobs	booleano	Se deveria devolver as probabilidades logarítmicas dos tokens de saída ou não. Se for verdadeiro, retorna as probabilidades logarítmicas de cada token de saída retornado no `content` de `message`.	No	Falso
top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade logarítmica associada. `logprobs` deve ser definido como `true` se esse parâmetro for usado.	No
n	inteiro	Quantas opções de conclusão de chat gerar para cada mensagem de entrada. Note que você será cobrado com base no número de tokens gerados em todas as opções. Mantenha-se `n` para `1` minimizar custos.	No	1
parallel_tool_calls	ParallelToolCalls	Se deve ativar a chamada paralela de funções durante o uso da ferramenta.	No	Verdade
formato_de_resposta	ResponseFormatText ou ResponseFormatJsonObject ou ResponseFormatJsonSchema	Um objeto que especifica o formato que o modelo deve gerar. Compatível com GPT-4o, GPT-4o mini, GPT-4 Turbo e todos os modelos GPT-3.5 Turbo mais novos que `gpt-3.5-turbo-1106`. Configurar para `{ "type": "json_schema", "json_schema": {...} }` ativa ativa o Structured Outputs, que garante que o modelo vai corresponder ao seu esquema JSON fornecido. Configurar para `{ "type": "json_object" }` ativar o modo JSON, que garante que a mensagem gerada pelo modelo é JSON válida. Importante: ao usar o modo JSON, você também deve instruir o modelo a produzir JSON você mesmo via uma mensagem do sistema ou do usuário. Sem isso, o modelo pode gerar um fluxo interminável de espaços em branco até que a geração atinja o limite do token, resultando em uma solicitação de longa duração e aparentemente "travada". Note também que o conteúdo da mensagem pode ser parcialmente cortado se `finish_reason="length"`, o que indica que a geração excedeu `max_tokens` ou a conversa excedeu o comprimento máximo do contexto.	No
seed	inteiro	Esse recurso está em Beta. Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que requisições repetidas com os mesmos `seed` parâmetros retornem o mesmo resultado. Determinismo não é garantido, e você deve consultar o `system_fingerprint` parâmetro de resposta para monitorar mudanças no backend.	No
tools	matriz	Uma lista de ferramentas que o modelo pode chamar. Atualmente, apenas funções são suportadas como ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. No máximo 128 funções são suportadas.	No
tool_choice	chatCompletionToolChoiceOption	Controle qual (se houver) ferramenta é chamada pelo modelo. `none` significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem. `auto` significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. `required` significa que o modelo deve chamar uma ou mais ferramentas. Especificar uma ferramenta específica força `{"type": "function", "function": {"name": "my_function"}}` o modelo a chamá-la. `none` é o padrão quando não há ferramentas presentes. `auto` é o padrão se as ferramentas estiverem presentes.	No
function_call	string ou chatCompletionFunctionCallOption	Descontinuado em favor de `tool_choice`. Controla qual (se houver) função é chamada pelo modelo. `none` significa que o modelo não chama uma função e, em vez disso, gera uma mensagem. `auto` significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma função. Especificar uma função específica via `{"name": "my_function"}` força o modelo a chamar essa função. `none` é o padrão quando nenhuma função está presente. `auto` é o padrão se as funções estiverem presentes.	No
functions	matriz	Descontinuado em favor de `tools`. Uma lista de funções para as quais o modelo pode gerar entradas JSON.	No

Respostas

Código de status: 200

Descrição: OK

Tipo de conteúdo	Tipo	Descrição
application/json	criarConversCompletionResposta ou criarChatCompletionStreamResposta

Código de status: padrão

Descrição: Serviço indisponível

Tipo de conteúdo	Tipo	Descrição
application/json	errorResponse

Exemplos

Example

Cria uma conclusão para o prompt fornecido, parâmetros e modelo escolhido.

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

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Respostas: Código de status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Cria uma conclusão baseada nos dados do Azure Search e na identidade gerenciada atribuída ao sistema.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Respostas: Código de status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Cria uma conclusão baseada nos dados do vetor de busca do Azure, mensagem do assistente anterior e identidade gerenciada atribuída pelo usuário.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respostas: Código de status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Cria uma conclusão para o Azure Cosmos DB fornecido.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respostas: Código de status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

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

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	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	ID de implantação do modelo de fala para texto. Para informações sobre modelos suportados, veja [/azure/ai-foundry/openai/concepts/models#audio-models].
versão da API	consulta	Yes	cadeia	Versão da API

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Descrição
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 é objeto para transcrever.	Yes
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 para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limites sejam atingidos.	No	0
linguagem	cadeia	O idioma do áudio de entrada. Fornecer a linguagem de entrada no formato ISO-639-1 melhorará a precisão e a latência.	No

Respostas

Código de status: 200

Descrição: OK

Tipo de conteúdo	Tipo	Descrição
application/json	audioResposta ou áudioVerboseResponse
texto/sem formatação	cadeia	Texto transcrito no formato de saída (quando response_format era de texto, 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=2024-10-21

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=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 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=2024-10-21

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	cadeia url	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	ID de implantação do modelo sussurrante que foi implantado. Para informações sobre modelos suportados, veja [/azure/ai-foundry/openai/concepts/models#audio-models].
versão da API	consulta	Yes	cadeia	Versão da API

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Descrição
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 para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limites sejam atingidos.	No	0

Respostas

Código de status: 200

Descrição: OK

Tipo de conteúdo	Tipo	Descrição
application/json	audioResposta ou áudioVerboseResponse
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=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 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=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 status: 200

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

Geração de imagem

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 em uma determinada implantação do modelo dall-e

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	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	ID de implantação do modelo dall-e que foi implantado.
versão da API	consulta	Yes	cadeia	Versão da API

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Descrição
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
solicitação	cadeia	Uma descrição em texto da(s) imagem(s) desejada(s). O comprimento máximo é de 4.000 caracteres.	Yes
n	inteiro	O número de imagens a serem geradas.	No	1
size	imageSize	O tamanho das imagens geradas.	No	1024x1024
formato_de_resposta	imagesResponseFormat	O formato no qual as imagens geradas são retornadas.	No	url
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos.	No
Qualidade	imageQuality	A qualidade da imagem que será gerada.	No	padrão
estilo	imageStyle	O estilo das imagens geradas.	No	Vívido

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=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 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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Componentes

errorResponse

Nome	Tipo	Descrição	Obrigatório	Default
erro	error		No

erroBase

Nome	Tipo	Descrição	Obrigatório	Default
codificar	cadeia		No
mensagem	cadeia		No

erro

Nome	Tipo	Descrição	Obrigatório
param	cadeia		No
tipo	cadeia		No
inner_error	innerError	Erro interno com detalhes adicionais.	No

innerError

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	contentFilterPromptResults	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

innerErrorCode

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

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

Tipo: cadeia de caracteres

Padrão:

Nome do Enum: InnerErrorCode

Valores de enumeração:

Valor	Descrição
ResponsibleAIPolicyViolation	O prompt violou uma das outras regras de filtro de conteúdo.

dalleErrorResponse

Nome	Tipo	Descrição	Obrigatório	Default
erro	dalleError		No

dalleError

Nome	Tipo	Descrição	Obrigatório
param	cadeia		No
tipo	cadeia		No
inner_error	dalleInnerError	Erro interno com detalhes adicionais.	No

dalleInnerError

Erro interno com detalhes adicionais.

Nome	Tipo	Descrição	Obrigatório
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

Base de Resultado do Filtro de Conteúdo

Nome	Tipo	Descrição	Obrigatório	Default
Filtrada	booleano		Yes

contentFilterSeverityResult

Nome	Tipo	Descrição	Obrigatório	Default
Filtrada	booleano		Yes
severity	cadeia		No

contentFilterDetectedResult

Nome	Tipo	Descrição	Obrigatório	Default
Filtrada	booleano		Yes
detectado	booleano		No

FiltroDeConteúdoDetectadoComResultadoDeCitação

Nome	Tipo	Descrição	Obrigatório	Default
Citação	objeto		No

Propriedades para citação

URL

Nome	Tipo	Descrição	Default
URL	cadeia

licença

Nome	Tipo	Descrição	Default
licença	cadeia

contentFilterResultsBase

Informações sobre os resultados do filtro de conteúdo.

Nome	Tipo	Obrigatório
sexual	Resultado de Severidade do Filtro de Conteúdo	No
Violência	Resultado de Severidade do Filtro de Conteúdo	No
Odeio	Resultado de Severidade do Filtro de Conteúdo	No
self_harm	Resultado de Severidade do Filtro de Conteúdo	No
Profanidade	Resultado de Filtro de Conteúdo Detectado	No
erro	errorBase	No

contentFilterPromptResults

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	Obrigatório
sexual	Resultado de Severidade do Filtro de Conteúdo	No
Violência	Resultado de Severidade do Filtro de Conteúdo	No
Odeio	Resultado de Severidade do Filtro de Conteúdo	No
self_harm	Resultado de Severidade do Filtro de Conteúdo	No
Profanidade	Resultado de Filtro de Conteúdo Detectado	No
erro	errorBase	No
jailbreak	Resultado de Filtro de Conteúdo Detectado	No

resultadosDaEscolhaDoFiltroDeConteúdo

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 textos de terceiros 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	Obrigatório
sexual	Resultado de Severidade do Filtro de Conteúdo	No
Violência	Resultado de Severidade do Filtro de Conteúdo	No
Odeio	Resultado de Severidade do Filtro de Conteúdo	No
self_harm	Resultado de Severidade do Filtro de Conteúdo	No
Profanidade	Resultado de Filtro de Conteúdo Detectado	No
erro	errorBase	No
protected_material_text	Resultado de Filtro de Conteúdo Detectado	No
protected_material_code	filtroDeConteúdoDetectadoComResultadoDeCitação	No

promptFilterResult

Filtragem de conteúdo resulta para um único prompt na solicitação.

Nome	Tipo	Descrição	Obrigatório	Default
prompt_index	inteiro		No
content_filter_results	contentFilterPromptResults	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

promptFiltrarResultados

Filtrar conteúdo resulta em nenhum ou mais prompts na solicitação. Em uma solicitação de streaming, os resultados de diferentes prompts podem chegar em horários ou ordens diferentes.

Nenhuma propriedade definida para esse componente.

Resultados do Filtro de Conteúdo Dalle

Informações sobre os resultados do filtro de conteúdo.

Nome	Tipo	Obrigatório
sexual	Resultado de Severidade do Filtro de Conteúdo	No
Violência	Resultado de Severidade do Filtro de Conteúdo	No
Odeio	Resultado de Severidade do Filtro de Conteúdo	No
self_harm	Resultado de Severidade do Filtro de Conteúdo	No

dalleFilterResults

Nome	Tipo	Obrigatório
sexual	Resultado de Severidade do Filtro de Conteúdo	No
Violência	Resultado de Severidade do Filtro de Conteúdo	No
Odeio	Resultado de Severidade do Filtro de Conteúdo	No
self_harm	Resultado de Severidade do Filtro de Conteúdo	No
Profanidade	Resultado de Filtro de Conteúdo Detectado	No
jailbreak	Resultado de Filtro de Conteúdo Detectado	No

chatCompletionsRequestCommon

Nome	Tipo	Descrição	Obrigatório	Default
Temperatura	number	Qual temperatura de amostragem usar, entre 0 e 2. 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. Geralmente recomendamos alterar isso ou `top_p` , mas não ambos.	No	1
top_p	number	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem a massa de probabilidade de 10 maiores% são considerados. Geralmente recomendamos alterar isso ou `temperature` , mas não ambos.	No	1
fluxo	booleano	Se ativado, serão enviados deltas parciais de mensagens, como no ChatGPT. Os tokens serão enviados apenas como eventos enviados pelo servidor apenas com dados assim que estiverem disponíveis, com o fluxo encerrado por uma `data: [DONE]` mensagem.	No	Falso
Parar	String ou array	Até quatro sequências em que a API para de gerar mais tokens.	No
número máximo de tokens	inteiro	O número máximo de tokens permitido para a resposta gerada. Por padrão, o número de tokens que o modelo pode devolver será (4096 - tokens de prompt). Esse valor agora foi descontinuado em favor de `max_completion_tokens`, e não é compatível com modelos da série O1.	No	4096
max_completion_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma conclusão, incluindo tokens de saída visíveis e tokens de raciocínio.	No
penalidade_de_presença	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua aparição no texto até então, aumentando a probabilidade do modelo de falar sobre novos temas.	No	0
frequency_penalty	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na frequência existente no texto até então, diminuindo a probabilidade do modelo repetir a mesma frase literalmente.	No	0
logit_bias	objeto	Modificar a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto json que mapeia tokens (especificados pelo ID de token no tokenizador) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará de modelo para modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar em banimento ou seleção exclusiva do token relevante.	No
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar o Azure OpenAI a monitorar e detectar abusos.	No

criarPedidoDeConclusão

Nome	Tipo	Descrição	Obrigatório	Default
solicitação	String ou array	O(s) prompt(s) para gerar completações para codificados como uma string, array de strings, array de tokens ou array de tokens. Note que <\|endoftext\|> é o separador de documentos que o modelo vê durante o treinamento, então, se um prompt não for especificado, o modelo será gerado como se fosse do início de um novo documento.	Yes
melhor_de	inteiro	Gera `best_of` conclusãos do lado do servidor e retorna o "melhor" (aquele com maior probabilidade logaritária por token). Os resultados não podem ser transmitidos em streaming. Quando usado com `n`, `best_of` controla o número de conclusãos candidatas e `n` especifica quantas devolver â€" `best_of` deve ser maior que `n`. Nota: Como esse parâmetro gera muitas conclusãos, ele pode rapidamente consumir sua cota de tokens. Use com cuidado e certifique-se de que você tenha configurações razoáveis para `max_tokens` e `stop`.	No	1
echo	booleano	Repita o prompt além da conclusão	No	Falso
frequency_penalty	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na frequência existente no texto até então, diminuindo a probabilidade do modelo repetir a mesma frase literalmente.	No	0
logit_bias	objeto	Modificar a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto JSON que mapeia tokens (especificados pelo ID do token no tokenizador GPT) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará de modelo para modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar em banimento ou seleção exclusiva do token relevante. Por exemplo, você pode passar `{"50256": -100}` para impedir que o <token \|endoftext\|> seja gerado.	No	Nenhum
logprobs	inteiro	Inclua as probabilidades logarítmicas dos `logprobs` tokens de saída mais prováveis, assim como os tokens escolhidos. Por exemplo, se `logprobs` for 5, a API retornará uma lista dos cinco tokens mais prováveis. A API sempre retornará o `logprob` do token amostrado, então pode haver até até `logprobs+1` elementos na resposta. O valor máximo para `logprobs` é 5.	No	Nenhum
número máximo de tokens	inteiro	O número máximo de tokens que podem ser gerados na conclusão. A contagem de tokens do seu prompt plus `max_tokens` não pode exceder o comprimento de contexto do modelo.	No	16
n	inteiro	Quantas conclusãos gerar para cada prompt. Nota: Como esse parâmetro gera muitas conclusãos, ele pode rapidamente consumir sua cota de tokens. Use com cuidado e certifique-se de que você tenha configurações razoáveis para `max_tokens` e `stop`.	No	1
penalidade_de_presença	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua aparição no texto até então, aumentando a probabilidade do modelo de falar sobre novos temas.	No	0
seed	inteiro	Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que requisições repetidas com os mesmos `seed` parâmetros retornem o mesmo resultado. Determinismo não é garantido, e você deve consultar o `system_fingerprint` parâmetro de resposta para monitorar mudanças no backend.	No
Parar	String ou array	Até quatro sequências em que a API para de gerar mais tokens. O texto devolvido não vai conter a sequência de paradas.	No
fluxo	booleano	Se deveria recuar o progresso parcial. Se ativados, os tokens serão enviados apenas como eventos enviados pelo servidor apenas por dados assim que estiverem disponíveis, com o fluxo encerrado por uma `data: [DONE]` mensagem.	No	Falso
Sufixo	cadeia	O sufixo que vem após a conclusão do texto inserido. Esse parâmetro é suportado apenas para `gpt-3.5-turbo-instruct`.	No	Nenhum
Temperatura	number	Qual temperatura de amostragem usar, entre 0 e 2. 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. Geralmente recomendamos alterar isso ou `top_p` , mas não ambos.	No	1
top_p	number	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem a massa de probabilidade de 10 maiores% são considerados. Geralmente recomendamos alterar isso ou `temperature` , mas não ambos.	No	1
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos.	No

createCompletionResponse

Representa uma resposta de conclusão da API. Nota: tanto os objetos de resposta transmitidos quanto os não transmitidos compartilham a mesma forma (diferente do endpoint do chat).

Nome	Tipo	Descrição	Obrigatório
id	cadeia	Um identificador único para a conclusão.	Yes
opções	matriz	A lista de escolhas de conclusão que o modelo gerou para o prompt de entrada.	Yes
criado	inteiro	O carimbo de tempo do Unix (em segundos) de quando a conclusão foi criada.	Yes
modelo	cadeia	O modelo usado para a conclusão.	Yes
prompt_filter_results	promptFilterResults	Filtrar conteúdo resulta em nenhum ou mais prompts na solicitação. Em uma solicitação de streaming, os resultados de diferentes prompts podem chegar em horários ou ordens diferentes.	No
system_fingerprint	cadeia	Essa impressão digital representa a configuração do backend com a qual o modelo roda. Pode ser usado em conjunto com o `seed` parâmetro de requisição para entender quando mudanças no backend foram feitas que possam impactar o determinismo.	No
objeto	enumeração	O tipo de objeto, que é sempre "text_completion" Valores possíveis: text_completion	Yes
uso	completionUsage	Estatísticas de uso para a solicitação de conclusão.	No

createChatCompletionRequest

Nome	Tipo	Descrição	Obrigatório	Default
Temperatura	number	Qual temperatura de amostragem usar, entre 0 e 2. 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. Geralmente recomendamos alterar isso ou `top_p` , mas não ambos.	No	1
top_p	number	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem a massa de probabilidade de 10 maiores% são considerados. Geralmente recomendamos alterar isso ou `temperature` , mas não ambos.	No	1
fluxo	booleano	Se ativado, serão enviados deltas parciais de mensagens, como no ChatGPT. Os tokens serão enviados apenas como eventos enviados pelo servidor apenas com dados assim que estiverem disponíveis, com o fluxo encerrado por uma `data: [DONE]` mensagem.	No	Falso
Parar	String ou array	Até quatro sequências em que a API para de gerar mais tokens.	No
número máximo de tokens	inteiro	O número máximo de tokens que podem ser gerados na conclusão do chat. O comprimento total dos tokens de entrada e dos tokens gerados é limitado pelo comprimento do contexto do modelo.	No
max_completion_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma conclusão, incluindo tokens de saída visíveis e tokens de raciocínio.	No
penalidade_de_presença	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua aparição no texto até então, aumentando a probabilidade do modelo de falar sobre novos temas.	No	0
frequency_penalty	number	Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na frequência existente no texto até então, diminuindo a probabilidade do modelo repetir a mesma frase literalmente.	No	0
logit_bias	objeto	Modificar a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto JSON que mapeia tokens (especificados pelo ID do token no tokenizador) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará de modelo para modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar em banimento ou seleção exclusiva do token relevante.	No	Nenhum
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos.	No
Mensagens	matriz	Uma lista de mensagens que compõem a conversa até agora.	Yes
data_sources	matriz	As entradas de configuração para as extensões de chat do Azure OpenAI que as utilizam. Essa especificação adicional é compatível apenas com o Azure OpenAI.	No
logprobs	booleano	Se deveria devolver as probabilidades logarítmicas dos tokens de saída ou não. Se for verdadeiro, retorna as probabilidades logarítmicas de cada token de saída retornado no `content` de `message`.	No	Falso
top_logprobs	inteiro	Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade logarítmica associada. `logprobs` deve ser definido como `true` se esse parâmetro for usado.	No
n	inteiro	Quantas opções de conclusão de chat gerar para cada mensagem de entrada. Note que você será cobrado com base no número de tokens gerados em todas as opções. Mantenha-se `n` para `1` minimizar custos.	No	1
parallel_tool_calls	ParallelToolCalls	Se deve ativar a chamada paralela de funções durante o uso da ferramenta.	No	Verdade
formato_de_resposta	ResponseFormatText ou ResponseFormatJsonObject ou ResponseFormatJsonSchema	Um objeto que especifica o formato que o modelo deve gerar. Compatível com GPT-4o, GPT-4o mini, GPT-4 Turbo e todos os modelos GPT-3.5 Turbo mais novos que `gpt-3.5-turbo-1106`. Configurar para `{ "type": "json_schema", "json_schema": {...} }` ativa ativa o Structured Outputs, que garante que o modelo vai corresponder ao seu esquema JSON fornecido. Configurar para `{ "type": "json_object" }` ativar o modo JSON, que garante que a mensagem gerada pelo modelo é JSON válida. Importante: ao usar o modo JSON, você também deve instruir o modelo a produzir JSON você mesmo via uma mensagem do sistema ou do usuário. Sem isso, o modelo pode gerar um fluxo interminável de espaços em branco até que a geração atinja o limite do token, resultando em uma solicitação de longa duração e aparentemente "travada". Note também que o conteúdo da mensagem pode ser parcialmente cortado se `finish_reason="length"`, o que indica que a geração excedeu `max_tokens` ou a conversa excedeu o comprimento máximo do contexto.	No
seed	inteiro	Esse recurso está em Beta. Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que requisições repetidas com os mesmos `seed` parâmetros retornem o mesmo resultado. Determinismo não é garantido, e você deve consultar o `system_fingerprint` parâmetro de resposta para monitorar mudanças no backend.	No
tools	matriz	Uma lista de ferramentas que o modelo pode chamar. Atualmente, apenas funções são suportadas como ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. No máximo 128 funções são suportadas.	No
tool_choice	chatCompletionToolChoiceOption	Controle qual (se houver) ferramenta é chamada pelo modelo. `none` significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem. `auto` significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. `required` significa que o modelo deve chamar uma ou mais ferramentas. Especificar uma ferramenta específica força `{"type": "function", "function": {"name": "my_function"}}` o modelo a chamá-la. `none` é o padrão quando não há ferramentas presentes. `auto` é o padrão se as ferramentas estiverem presentes.	No
function_call	string ou chatCompletionFunctionCallOption	Descontinuado em favor de `tool_choice`. Controla qual (se houver) função é chamada pelo modelo. `none` significa que o modelo não chama uma função e, em vez disso, gera uma mensagem. `auto` significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma função. Especificar uma função específica via `{"name": "my_function"}` força o modelo a chamar essa função. `none` é o padrão quando nenhuma função está presente. `auto` é o padrão se as funções estiverem presentes.	No
functions	matriz	Descontinuado em favor de `tools`. Uma lista de funções para as quais o modelo pode gerar entradas JSON.	No

FunçõesDeConclusãoDoChat

Nome	Tipo	Descrição	Obrigatório
descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
name	cadeia	O nome da função a ser chamada. Devem ser de a z, de A a Z, de 0 a 9, ou conter sublinhaduras e traços, com comprimento máximo de 64.	Yes
parameters	FunctionParameters	Os parâmetros que as funções aceitam, descritos como um objeto de Esquema JSON. Veja o guia para exemplos e a referência do Esquema JSON para documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	No

chatCompletionFunctionCallOption

Especificar uma função específica via {"name": "my_function"} força o modelo a chamar essa função.

Nome	Tipo	Descrição	Obrigatório	Default
name	cadeia	O nome da função a ser chamada.	Yes

chatCompletionRequestMessage

Esse componente pode ser um dos seguintes:

chatCompletionRequestSystemMessage

Nome	Tipo	Descrição	Obrigatório
conteúdo	String ou array	O conteúdo da mensagem do sistema.	Yes
função	enumeração	O papel do autor das mensagens, neste caso `system`. Valores possíveis: sistema	Yes
name	cadeia	Um nome opcional para o participante. Fornece informações do modelo para diferenciar entre participantes do mesmo papel.	No

chatCompletionRequestUserMessage

Nome	Tipo	Descrição	Obrigatório
conteúdo	String ou array	O conteúdo da mensagem do usuário.	Yes
função	enumeração	O papel do autor das mensagens, neste caso `user`. Valores possíveis: usuário	Yes
name	cadeia	Um nome opcional para o participante. Fornece informações do modelo para diferenciar entre participantes do mesmo papel.	No

chatCompletionRequestAssistantMessage

Nome	Tipo	Descrição	Obrigatório
conteúdo	String ou array	O conteúdo da mensagem do assistente. Obrigatório, a menos que `tool_calls` seja especificado ou `function_call` especificado.	No
Recusa	cadeia	A mensagem de recusa do assistente.	No
função	enumeração	O papel do autor das mensagens, neste caso `assistant`. Valores possíveis: assistente	Yes
name	cadeia	Um nome opcional para o participante. Fornece informações do modelo para diferenciar entre participantes do mesmo papel.	No
tool_calls	chatCompletionMessageToolCalls	As chamadas de ferramenta geradas pelo modelo, como chamadas de função.	No
function_call	objeto	Descontinuado e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	No

Propriedades para function_call

argumentos

Nome	Tipo	Descrição	Default
argumentos	cadeia	Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode gerar parâmetros não definidos pelo seu esquema de funções. Valide os argumentos no seu código antes de chamar sua função.

name

Nome	Tipo	Descrição	Default
name	cadeia	O nome da função a ser chamada.

chatCompletionRequestToolMessage

Nome	Tipo	Descrição	Obrigatório
função	enumeração	O papel do autor das mensagens, neste caso `tool`. Valores possíveis: ferramenta	Yes
conteúdo	String ou array	O conteúdo da mensagem da ferramenta.	Yes
tool_call_id	cadeia	Chamada de ferramenta à qual essa mensagem está respondendo.	Yes

chatCompletionRequestFunctionMessage

Nome	Tipo	Descrição	Obrigatório
função	enumeração	O papel do autor das mensagens, neste caso `function`. Valores possíveis: função	Yes
conteúdo	cadeia	O conteúdo da mensagem funcional.	Yes
name	cadeia	O nome da função a ser chamada.	Yes

chatCompletionRequestSystemMessageContentPart

Esse componente pode ser um dos seguintes:

chatCompletionRequestUserMessageContentPart

Esse componente pode ser um dos seguintes:

chatCompletionRequestAssistantMessageContentPart

Esse componente pode ser um dos seguintes:

ParteDoConteúdoDaMensagemDaFerramentaDeSolicitaçãoDeConclusãoDoChat

Esse componente pode ser um dos seguintes:

chatCompletionRequestMessageContentPartText

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo do conteúdo é a parte. Valores possíveis: texto	Yes
enviar SMS	cadeia	O conteúdo do texto.	Yes

chatCompletionRequestMessageContentPartImage

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo do conteúdo é a parte. Valores possíveis: image_url	Yes
image_url	objeto		Yes

Propriedades para image_url

url

Nome	Tipo	Descrição	Default
url	cadeia	Ou uma URL da imagem ou os dados da imagem codificada base64.

detail

Nome	Tipo	Descrição	Default
detail	cadeia	Especifica o nível de detalhe da imagem. Saiba mais no guia Visão.	automático

chatCompletionRequestMessageContentPartRefusal

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo do conteúdo é a parte. Valores possíveis: recusa	Yes
Recusa	cadeia	A mensagem de recusa gerada pelo modelo.	Yes

Configuração da Extensão do Azure Chat

Uma representação dos dados de configuração para uma única extensão de chat do Azure OpenAI. Isso será usado por uma solicitação de conclusão de chat que deve usar extensões de chat do Azure OpenAI para complementar o comportamento de resposta. O uso dessa configuração é compatível apenas com o Azure OpenAI.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	azureChatExtensionType	Uma representação dos dados de configuração para uma única extensão de chat do Azure OpenAI. Isso será usado por um chat completions solicitam que devem usar extensões de chat do Azure OpenAI para aumentar o comportamento de resposta. O uso dessa configuração é compatível apenas com o Azure OpenAI.	Yes

azureChatExtensionType

Description: Uma representação dos dados de configuração para uma única extensão de chat OpenAI Azure. Isso será usado por uma solicitação de conclusão de chat que deve usar extensões de chat do Azure OpenAI para complementar o comportamento de resposta. O uso dessa configuração é compatível apenas com o Azure OpenAI.

Tipo: cadeia de caracteres

Padrão:

Nome da enumeração: AzureChatExtensionType

Valores de enumeração:

Valor	Descrição
Azure Search	Representa o uso do Azure Search como uma extensão de chat do Azure OpenAI.
azure_cosmos_db	Representa o uso do Azure Cosmos DB como uma extensão de chat do Azure OpenAI.

Configuração de Extensão de Chat do AzureSearch

Uma representação específica das opções configuráveis para o Azure Search ao usá-lo como uma extensão de chat do Azure OpenAI.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	azureChatExtensionType	Uma representação dos dados de configuração para uma única extensão de chat do Azure OpenAI. Isso será usado por um chat completions solicitam que devem usar extensões de chat do Azure OpenAI para aumentar o comportamento de resposta. O uso dessa configuração é compatível apenas com o Azure OpenAI.	Yes
parameters	azureSearchChatExtensionParameters	Parâmetros para Azure Search quando usados como uma extensão de chat do Azure OpenAI.	No

azureSearchChatExtensionParameters

Parâmetros para Azure Search quando usados como uma extensão de chat do Azure OpenAI.

Nome	Tipo	Descrição	Obrigatório
autenticação	onSeuDataApiChaveOpções de Autenticação ou onSeuDataSystemAssignadoGerenciadoIdentidadeOpções de Autenticação ou onSeuDataUsuárioAssignadoGerenciadoIdentidadeOpções de Autenticação		Yes
top_n_documents	inteiro	O número superior configurado de documentos a serem destacados para a consulta configurada.	No
in_scope	booleano	Se consultas deveriam ser restritas ao uso de dados indexados.	No
Rigor	inteiro	A rigidez configurada do filtro de relevância de busca. Quanto maior a rigor, maior a precisão, mas menor a recordação da resposta.	No
informações_de_função	cadeia	Forneça ao modelo instruções sobre como ele deve se comportar e qualquer contexto que ele deve referenciar ao gerar uma resposta. Você pode descrever a personalidade do assistente e explicar como formatar as respostas. Há um limite de 100 tokens para ele, e ele conta contra o limite total de tokens.	No
ponto de extremidade	cadeia	O caminho de endpoint absoluto para o recurso do Azure Search usar.	Yes
nome_do_indice	cadeia	O nome do índice a ser usado como disponível no recurso de pesquisa do Azure referenciado.	Yes
mapeamento_de_campos	azureSearchIndexFieldMappingOptions	Configurações opcionais para controlar como os campos são processados ao usar um recurso de busca do Azure configurado.	No
tipo_de_consulta	azureSearchQueryType	O tipo de consulta de recuperação do Azure Search que deve ser executada ao usá-lo como uma extensão de chat do Azure OpenAI.	No
configuração_semântica	cadeia	A configuração semântica adicional para a consulta.	No
filtro	cadeia	Filtro de pesquisa.	No
embedding_dependency	onSeuDataDataEndpointVectorizaçãoFonte ou onSeuDataDeploymentNomeVectorizaçãoFonte		No

Opções de Mapeamento de Campos de Índice de Pesquisa Azure

Configurações opcionais para controlar como os campos são processados ao usar um recurso de busca do Azure configurado.

Nome	Tipo	Descrição	Obrigatório
campo_título	cadeia	O nome do campo índice para usar como título.	No
url_field	cadeia	O nome do campo índice a usar como URL.	No
filepath_field	cadeia	O nome do campo índice a usar como caminho de arquivo.	No
campos de conteúdo	matriz	Os nomes dos campos de índice que devem ser tratados como conteúdo.	No
separador_de_campos_de_conteúdo	cadeia	O padrão de separação que os campos de conteúdo devem usar.	No
campos vetoriais	matriz	Os nomes dos campos que representam dados vetoriais.	No

azureSearchQueryType

O tipo de consulta de recuperação do Azure Search que deve ser executada ao usá-lo como uma extensão de chat do Azure OpenAI.

Description: O tipo de consulta de recuperação de busca Azure que deve ser executada ao usá-la como uma extensão de chat Azure OpenAI.

Tipo: cadeia de caracteres

Padrão:

Nome da enumeração: AzureSearchQueryType

Valores de enumeração:

Valor	Descrição
Simples	Representa o parser de consultas padrão e simples.
Semântica	Representa o parser de consultas semânticas para modelagem semântica avançada.
vetor	Representa busca vetorial sobre dados calculados.
vector_simple_hybrid	Representa uma combinação da estratégia simples de consulta com dados vetoriais.
vetor_semântico_híbrido	Representa uma combinação de busca semântica e consulta vetorial de dados.

azureCosmosDBChatExtensionConfiguration

Uma representação específica das opções configuráveis para o Azure Cosmos DB ao usá-lo como uma extensão de chat do Azure OpenAI.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	azureChatExtensionType	Uma representação dos dados de configuração para uma única extensão de chat do Azure OpenAI. Isso será usado por um chat completions solicitam que devem usar extensões de chat do Azure OpenAI para aumentar o comportamento de resposta. O uso dessa configuração é compatível apenas com o Azure OpenAI.	Yes
parameters	azureCosmosDBChatExtensionParameters	Parâmetros a serem usados ao configurar extensões de chat do Azure OpenAI On Your Data ao usar o Azure Cosmos DB para MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

Parâmetros a serem usados ao configurar extensões do chat do Azure OpenAI On Your Data ao usar o Azure Cosmos DB para MongoDB vCore.

Nome	Tipo	Descrição	Obrigatório
autenticação	onYourDataConnectionStringAuthenticationOptions	As opções de autenticação do Azure OpenAI On Your Data ao usar uma cadeia de conexão.	Yes
top_n_documents	inteiro	O número superior configurado de documentos a serem destacados para a consulta configurada.	No
in_scope	booleano	Se consultas deveriam ser restritas ao uso de dados indexados.	No
Rigor	inteiro	A rigidez configurada do filtro de relevância de busca. Quanto maior a rigor, maior a precisão, mas menor a recordação da resposta.	No
informações_de_função	cadeia	Forneça ao modelo instruções sobre como ele deve se comportar e qualquer contexto que ele deve referenciar ao gerar uma resposta. Você pode descrever a personalidade do assistente e explicar como formatar as respostas. Há um limite de 100 tokens para ele, e ele conta contra o limite total de tokens.	No
nome_do_banco_de_dados	cadeia	O nome do banco de dados MongoDB vCore para usar com o Azure Cosmos DB.	Yes
nome_do_container	cadeia	O nome do contêiner de recursos do Azure Cosmos DB.	Yes
nome_do_indice	cadeia	O nome do índice do MongoDB vCore para usar com o Azure Cosmos DB.	Yes
mapeamento_de_campos	azureCosmosDBFieldMappingOptions	Configurações opcionais para controlar como os campos são processados ao usar um recurso do Azure Cosmos DB configurado.	Yes
embedding_dependency	onSeuDataDataEndpointVectorizaçãoFonte ou onSeuDataDeploymentNomeVectorizaçãoFonte		Yes

Opções de Mapeamento de Campo do azureCosmosDB

Configurações opcionais para controlar como os campos são processados ao usar um recurso do Azure Cosmos DB configurado.

Nome	Tipo	Descrição	Obrigatório
campo_título	cadeia	O nome do campo índice para usar como título.	No
url_field	cadeia	O nome do campo índice a usar como URL.	No
filepath_field	cadeia	O nome do campo índice a usar como caminho de arquivo.	No
campos de conteúdo	matriz	Os nomes dos campos de índice que devem ser tratados como conteúdo.	Yes
separador_de_campos_de_conteúdo	cadeia	O padrão de separação que os campos de conteúdo devem usar.	No
campos vetoriais	matriz	Os nomes dos campos que representam dados vetoriais.	Yes

opçõesDeAutenticaçãoDosSeusDados

As opções de autenticação para Azure OpenAI On Your Data.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataAuthenticationType	Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.	Yes

onYourDataAuthenticationType

Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.

Description: Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.

Tipo: cadeia de caracteres

Padrão:

Nome Enum: OnYourDataAuthenticationType

Valores de enumeração:

Valor	Descrição
chave_de_api	Autenticação via chave API.
connection_string	Autenticação via cadeia de conexão.
system_assigned_managed_identity	Autenticação via identidade gerenciada atribuída ao sistema.
user_assigned_managed_identity	Autenticação via identidade gerenciada atribuída pelo usuário.

onYourDataApiKeyAuthenticationOptions

As opções de autenticação para Azure OpenAI On Your Data ao usar uma chave API.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataAuthenticationType	Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.	Yes
chave	cadeia	A chave de API para usar para autenticação.	No

onYourDataConnectionStringAuthenticationOptions

As opções de autenticação do Azure OpenAI On Your Data ao usar uma cadeia de conexão.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataAuthenticationType	Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.	Yes
connection_string	cadeia	A cadeia de conexão para usar para autenticação.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

As opções de autenticação para Azure OpenAI On Your Data ao usar uma identidade gerenciada atribuída pelo sistema.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataAuthenticationType	Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

As opções de autenticação para Azure OpenAI On Your Data ao usar uma identidade gerenciada atribuída pelo usuário.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataAuthenticationType	Os tipos de autenticação suportados pelo Azure OpenAI On Your Data.	Yes
managed_identity_resource_id	cadeia	O ID de recurso da identidade gerenciada atribuída pelo usuário para ser usada para autenticação.	No

onYourDataVectorizationSource

Uma representação abstrata de uma fonte de vetorização para Azure OpenAI On Your Data com busca vetorial.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataVectorizationSourceType	Representa as fontes disponíveis que o Azure OpenAI On Your Data pode usar para configurar vetorização de dados para uso com pesquisa de vetor.	Yes

onYourDataVectorizationSourceType

Representa as fontes disponíveis que o Azure OpenAI On Your Data pode usar para configurar vetorização dos dados para uso em busca vetorial.

Description: Representa as fontes disponíveis Azure o OpenAI On Your Data pode usar para configurar a vetorização dos dados para uso com
pesquisa de vetor.

Tipo: cadeia de caracteres

Padrão:

Nome Enum: OnYourDataVectorizationSourceType

Valores de enumeração:

Valor	Descrição
ponto de extremidade	Representa vetorização realizada por chamadas de serviço público para um modelo de embedding do Azure OpenAI.
nome_do_desdobramento	Representa o nome de um modelo de implantação Ada a ser usado. Essa implantação do modelo deve estar no mesmo recurso do Azure OpenAI, mas O On Your Data usará esse modelo para implantação via uma chamada interna em vez de pública, o que permite vetor Procure até mesmo em redes privadas.

onYourDataDeploymentNameVectorizationSource

Os detalhes de uma fonte de vetorização, usada pelo Azure OpenAI On Your Data ao aplicar busca vetorial, que é baseada em um nome interno de implantação de modelo de embeddings no mesmo recurso Azure OpenAI.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	onYourDataVectorizationSourceType	Representa as fontes disponíveis que o Azure OpenAI On Your Data pode usar para configurar vetorização de dados para uso com pesquisa de vetor.	Yes
nome_do_desdobramento	cadeia	Especifica o nome da implantação do modelo a ser usada para vetorização. Essa implantação do modelo deve ser no mesmo recurso Azure OpenAI, mas a On Your Data usará essa implantação do modelo por meio de uma chamada interna em vez de pública, o que permite busca vetorial mesmo em redes privadas.	No

onYourDataEndpointVectorizationSource

Os detalhes de uma fonte de vetorização, usada pelo Azure OpenAI On Your Data ao aplicar busca vetorial, que é baseada em uma chamada pública de endpoint do Azure OpenAI para embeddings.

Nome	Tipo	Descrição	Obrigatório
tipo	onYourDataVectorizationSourceType	Representa as fontes disponíveis que o Azure OpenAI On Your Data pode usar para configurar vetorização de dados para uso com pesquisa de vetor.	Yes
autenticação	onYourDataApiKeyAuthenticationOptions	As opções de autenticação para Azure OpenAI On Your Data ao usar uma chave API.	No
ponto de extremidade	cadeia	Especifica o ponto final a ser usado para vetorização. Esse endpoint deve estar no mesmo recurso do Azure OpenAI, mas o On Your Data usará esse endpoint por meio de uma chamada interna em vez de pública, o que permite busca vetorial mesmo em redes privadas.	No

azureChatExtensionsMessageContext

Uma representação das informações adicionais de contexto disponíveis quando extensões de chat do Azure OpenAI estão envolvidas na geração de uma resposta correspondente de conclusão de chat. Essa informação de contexto só é preenchida quando se usa uma requisição OpenAI do Azure configurada para usar uma extensão correspondente.

Nome	Tipo	Descrição	Obrigatório	Default
citações	matriz	O resultado da recuperação da fonte de dados, usado para gerar a mensagem assistente na resposta.	No
intenção	cadeia	A intenção detectada do histórico do chat, usada para passar para o próximo turno para manter o contexto.	No

Citação

Informações de citação para uma mensagem de resposta de conclusão de chat.

Nome	Tipo	Descrição	Obrigatório
conteúdo	cadeia	O conteúdo da citação.	Yes
title	cadeia	O título da citação.	No
url	cadeia	A URL da citação.	No
FilePath	cadeia	O caminho do arquivo da citação.	No
identificador_de_fragmento	cadeia	O ID do bloco da multa.	No

chatCompletionMessageToolCall

Nome	Tipo	Descrição	Obrigatório
id	cadeia	O ID da chamada de ferramenta.	Yes
tipo	toolCallType	O tipo de chamada de ferramenta, neste caso `function`.	Yes
função	objeto	A função que o modelo chamou.	Yes

Propriedades para função

name

Nome	Tipo	Descrição	Default
name	cadeia	O nome da função a ser chamada.

argumentos

Nome	Tipo	Descrição	Default
argumentos	cadeia	Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode gerar parâmetros não definidos pelo seu esquema de funções. Valide os argumentos no seu código antes de chamar sua função.

toolCallType

O tipo de chamada de ferramenta, neste caso function.

Descrição: O tipo da chamada de ferramenta, neste caso function.

Tipo: cadeia de caracteres

Padrão:

Nome do Enum: ToolCallType

Valores de enumeração:

Valor	Descrição
função	O tipo de chamada de ferramenta é função.

chatCompletionRequestMessageTool

Nome	Tipo	Descrição	Obrigatório	Default
tool_call_id	cadeia	Chamada de ferramenta à qual essa mensagem está respondendo.	No
conteúdo	cadeia	O conteúdo da mensagem.	No

função de conclusão de solicitação de mensagem de chat

Nome	Tipo	Descrição	Obrigatório
função	enumeração	O papel do autor das mensagens, neste caso `function`. Valores possíveis: função	No
name	cadeia	O conteúdo da mensagem.	No
conteúdo	cadeia	O conteúdo da mensagem.	No

createChatCompletionResponse

Representa uma resposta de conclusão do chat retornada pelo modelo, com base na entrada fornecida.

Nome	Tipo	Descrição	Obrigatório
id	cadeia	Um identificador único para a conclusão do chat.	Yes
prompt_filter_results	promptFilterResults	Filtrar conteúdo resulta em nenhum ou mais prompts na solicitação. Em uma solicitação de streaming, os resultados de diferentes prompts podem chegar em horários ou ordens diferentes.	No
opções	matriz	Uma lista de opções para completar o chat. Pode ser mais de um se `n` for maior que 1.	Yes
criado	inteiro	O carimbo de tempo do Unix (em segundos) de quando a conclusão do chat foi criada.	Yes
modelo	cadeia	O modelo usado para completar o chat.	Yes
system_fingerprint	cadeia	Essa impressão digital representa a configuração do backend com a qual o modelo roda. Pode ser usado em conjunto com o `seed` parâmetro de requisição para entender quando mudanças no backend foram feitas que possam impactar o determinismo.	No
objeto	enumeração	O tipo de objeto, que é sempre `chat.completion`. Valores possíveis: chat.completion	Yes
uso	completionUsage	Estatísticas de uso para a solicitação de conclusão.	No

createChatCompletionStreamResponse

Representa um trecho transmitido de uma resposta de conclusão de chat retornada pelo modelo, com base na entrada fornecida.

Nome	Tipo	Descrição	Obrigatório
id	cadeia	Um identificador único para a conclusão do chat. Cada bloco tem o mesmo ID.	Yes
opções	matriz	Uma lista de opções para completar o chat. Pode conter mais de um elemento se `n` for maior que 1.	Yes
criado	inteiro	O carimbo de tempo do Unix (em segundos) de quando a conclusão do chat foi criada. Cada bloco tem o mesmo carimbo de data.	Yes
modelo	cadeia	O modelo para gerar a completude.	Yes
system_fingerprint	cadeia	Essa impressão digital representa a configuração do backend com a qual o modelo roda. Pode ser usado em conjunto com o `seed` parâmetro de requisição para entender quando mudanças no backend foram feitas que possam impactar o determinismo.	No
objeto	enumeração	O tipo de objeto, que é sempre `chat.completion.chunk`. Valores possíveis: chat.completion.chunk	Yes

chatCompletionStreamResponseDelta

Um delta de conclusão do chat gerado por respostas de modelos transmitidos.

Nome	Tipo	Descrição	Obrigatório
conteúdo	cadeia	O conteúdo da mensagem do bloco.	No
function_call	objeto	Descontinuado e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	No
tool_calls	matriz		No
função	enumeração	O papel do autor desta mensagem. Valores possíveis: sistema, usuário, assistente, ferramenta	No
Recusa	cadeia	A mensagem de recusa gerada pelo modelo.	No

Propriedades para function_call

argumentos

Nome	Tipo	Descrição	Default
argumentos	cadeia	Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode gerar parâmetros não definidos pelo seu esquema de funções. Valide os argumentos no seu código antes de chamar sua função.

name

Nome	Tipo	Descrição	Default
name	cadeia	O nome da função a ser chamada.

chatCompletionMessageToolCallChunk

Nome	Tipo	Descrição	Obrigatório
indexar	inteiro		Yes
id	cadeia	O ID da chamada de ferramenta.	No
tipo	enumeração	O tipo da ferramenta. Atualmente, somente `function` é suportado. Valores possíveis: função	No
função	objeto		No

Propriedades para função

name

Nome	Tipo	Descrição	Default
name	cadeia	O nome da função a ser chamada.

argumentos

Nome	Tipo	Descrição	Default
argumentos	cadeia	Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode gerar parâmetros não definidos pelo seu esquema de funções. Valide os argumentos no seu código antes de chamar sua função.

chatCompletionStreamOptions

Opções para resposta ao streaming. Só define isso quando você define stream: true.

Nome	Tipo	Descrição	Obrigatório	Default
include_usage	booleano	Se ativado, um pedaço adicional será transmitido antes da `data: [DONE]` mensagem. O `usage` campo nesse bloco mostra as estatísticas de uso do token para toda a requisição, e o `choices` campo sempre será um array vazio. Todos os outros chunks também incluirão um `usage` corpo, mas com valor nulo.	No

chatCompletionChoiceLogProbs

Registre as informações de probabilidade para a escolha.

Nome	Tipo	Descrição	Obrigatório	Default
conteúdo	matriz	Uma lista de tokens de conteúdo de mensagens com informações de probabilidade logarítmica.	Yes
Recusa	matriz	Uma lista de tokens de recusa de mensagens com informações de probabilidade logarítmica.	No

chatCompletionTokenLogprob

Nome	Tipo	Descrição	Obrigatório
símbolo	cadeia	O token.	Yes
logprob	number	A probabilidade logarítmica desse token.	Yes
Bytes	matriz	Uma lista de inteiros representando a representação UTF-8 bytes do token. Útil em casos em que caracteres são representados por múltiplos tokens e suas representações em bytes precisam ser combinadas para gerar a representação correta do texto. Pode ser `null` se não houver representação em bytes para o token.	Yes
top_logprobs	matriz	Lista dos tokens mais prováveis e sua probabilidade logarítmica, nesta posição do token. Em casos raros, pode haver menos do que o número de solicitados `top_logprobs` devolvidos.	Yes

chatCompletionResponseMessage

Uma mensagem de conclusão do chat gerada pelo modelo.

Nome	Tipo	Descrição	Obrigatório
função	chatCompletionResponseMessageRole	O papel do autor da mensagem de resposta.	Yes
Recusa	cadeia	A mensagem de recusa gerada pelo modelo.	Yes
conteúdo	cadeia	O conteúdo da mensagem.	Yes
tool_calls	matriz	As chamadas de ferramenta geradas pelo modelo, como chamadas de função.	No
function_call	chatCompletionFunctionCall	Descontinuado e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	No
contexto	azureChatExtensionsMessageContext	Uma representação das informações adicionais de contexto disponíveis quando extensões de chat do Azure OpenAI estão envolvidas na geração de uma resposta correspondente de conclusão de chat. Essa informação de contexto só é preenchida quando usando uma requisição do OpenAI do Azure configurada para usar uma extensão correspondente.	No

chatCompletionResponseMessageRole

O papel do autor da mensagem de resposta.

Descrição: O papel do autor da mensagem de resposta.

Tipo: cadeia de caracteres

Padrão:

Valores de enumeração:

assistente

chatCompletionToolChoiceOption

Controle qual (se houver) ferramenta é chamada pelo modelo. none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas. Especificar uma ferramenta específica força {"type": "function", "function": {"name": "my_function"}} o modelo a chamá-la. none é o padrão quando não há ferramentas presentes. auto é o padrão se as ferramentas estiverem presentes.

Esse componente pode ser um dos seguintes:

chatCompletionNamedToolChoice

Especifica uma ferramenta que o modelo deve usar. Use para forçar o modelo a chamar uma função específica.

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo da ferramenta. Atualmente, somente `function` é suportado. Valores possíveis: função	Yes
função	objeto		Yes

Propriedades para função

name

Nome	Tipo	Descrição	Default
name	cadeia	O nome da função a ser chamada.

ParallelToolCalls

Se deve ativar a chamada paralela de funções durante o uso da ferramenta.

Nenhuma propriedade definida para esse componente.

chatCompletionMessageToolCalls

As chamadas de ferramenta geradas pelo modelo, como chamadas de função.

Nenhuma propriedade definida para esse componente.

chatCompletionFunctionCall

Descontinuado e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.

Nome	Tipo	Descrição	Obrigatório	Default
name	cadeia	O nome da função a ser chamada.	Yes
argumentos	cadeia	Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode gerar parâmetros não definidos pelo seu esquema de funções. Valide os argumentos no seu código antes de chamar sua função.	Yes

completionUsage

Estatísticas de uso para a solicitação de conclusão.

Nome	Tipo	Descrição	Obrigatório
prompt_tokens	inteiro	Número de tokens no prompt.	Yes
completion_tokens	inteiro	Número de tokens na conclusão gerada.	Yes
total_tokens	inteiro	Número total de tokens usados na solicitação (prompt + conclusão).	Yes
completion_tokens_details	objeto	Análise dos tokens usados em uma conclusão.	No

Propriedades para completion_tokens_details

reasoning_tokens

Nome	Tipo	Descrição	Default
reasoning_tokens	inteiro	Tokens gerados pelo modelo para raciocínio.

chatCompletionTool

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo da ferramenta. Atualmente, somente `function` é suportado. Valores possíveis: função	Yes
função	FunctionObject		Yes

FunctionParameters

Os parâmetros que as funções aceitam, descritos como um objeto de Esquema JSON. Veja o guia para exemplos e a referência do Esquema JSON para documentação sobre o formato.

Omitir parameters define uma função com uma lista de parâmetros vazia.

Nenhuma propriedade definida para esse componente.

FunctionObject

Nome	Tipo	Descrição	Obrigatório	Default
descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	No
name	cadeia	O nome da função a ser chamada. Devem ser de a z, de A a Z, de 0 a 9, ou conter sublinhaduras e traços, com comprimento máximo de 64.	Yes
parameters	FunctionParameters	Os parâmetros que as funções aceitam, descritos como um objeto de Esquema JSON. Veja o guia para exemplos e a referência do Esquema JSON para documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	No
rigoroso	booleano	Se deve permitir a adesão estrita ao esquema ao gerar a chamada de função. Se definido como verdadeiro, o modelo seguirá exatamente o esquema definido no `parameters` campo. Apenas um subconjunto do Esquema JSON é suportado quando `strict` é `true`.	No	Falso

FormatoDeTextoDaResposta

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo de formato de resposta definido: `text` Valores possíveis: texto	Yes

ResponseFormatJsonObject

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo de formato de resposta definido: `json_object` Valores possíveis: json_object	Yes

ResponseFormatJsonSchemaSchema

O esquema para o formato de resposta, descrito como um objeto de Esquema JSON.

Nenhuma propriedade definida para esse componente.

FormatoDeRespostaJsonSchema

Nome	Tipo	Descrição	Obrigatório	Default
tipo	enumeração	O tipo de formato de resposta definido: `json_schema` Valores possíveis: json_schema	Yes
json_schema	objeto		Yes

Propriedades para json_schema

descrição

Nome	Tipo	Descrição	Default
descrição	cadeia	Uma descrição do que serve o formato de resposta, usada pelo modelo para determinar como responder no formato.

name

Nome	Tipo	Descrição	Default
name	cadeia	O nome do formato da resposta. Devem ser de a z, de A a Z, de 0 a 9, ou conter sublinhaduras e traços, com comprimento máximo de 64.

esquema

Nome	Tipo	Descrição	Default
esquema	ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de Esquema JSON.

rigoroso

Nome	Tipo	Descrição	Default
rigoroso	booleano	Se deve ativar a adesão estrita ao esquema ao gerar a saída. Se definido como verdadeiro, o modelo sempre seguirá exatamente o esquema definido no `schema` campo. Apenas um subconjunto do Esquema JSON é suportado quando `strict` é `true`.	Falso

chatCompletionChoiceCommon

Nome	Tipo	Descrição	Obrigatório	Default
indexar	inteiro		No
motivo_de_conclusão	cadeia		No

criarSolicitaçãoDeTradução

Solicitação de tradução.

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 para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limites sejam atingidos.	No	0

audioResponse

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

Nome	Tipo	Descrição	Obrigatório	Default
enviar SMS	cadeia	Texto traduzido ou transcrito.	Yes

audioVerboseResponse

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

Nome	Tipo	Descrição	Obrigatório
enviar SMS	cadeia	Texto traduzido ou transcrito.	Yes
tarefa	cadeia	Tipo de tarefa de áudio.	No
linguagem	cadeia	Language.	No
duração	number	Duração.	No
Segmentos	matriz		No

audioResponseFormat

Define o formato da saída.

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

Tipo: cadeia de caracteres

Padrão:

Valores de enumeração:

Json
enviar SMS
srt
verbose_json
vtt

criarSolicitaçãoDeTranscrição

Solicitação de transcrição.

Nome	Tipo	Descrição	Obrigatório	Default
arquivo	cadeia	O arquivo de áudio é objeto para transcrever.	Yes
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 para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limites sejam atingidos.	No	0
linguagem	cadeia	O idioma do áudio de entrada. Fornecer a linguagem de entrada no formato ISO-639-1 melhorará a precisão e a latência.	No

segmento de áudio

Segmento de transcrição ou tradução.

Nome	Tipo	Descrição	Obrigatório
id	inteiro	Identificador de segmento.	No
Procurar	number	Deslocamento do segmento.	No
iniciar	number	Início do segmento deslocado.	No
end	number	Deslocamento no final do segmento.	No
enviar SMS	cadeia	Texto do segmento.	No
tokens	matriz	Símbolos do texto.	No
Temperatura	number	Temperatura.	No
avg_logprob	number	Probabilidade logarítmica média.	No
compression_ratio	number	Taxa de compactação.	No
no_speech_prob	number	Probabilidade de `no speech`.	No

imageQuality

A qualidade da imagem que será gerada.

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

Tipo: cadeia de caracteres

Padrão: padrão

Nome Enum: Quality

Valores de enumeração:

Valor	Descrição
padrão	Qualidade padrão cria imagens com qualidade padrão.
hd	A qualidade HD cria imagens com detalhes mais finos e maior consistência em toda a imagem.

imagesResponseFormat

O formato no qual as imagens geradas são retornadas.

Descrição: O formato no qual as imagens geradas são retornadas.

Tipo: cadeia de caracteres

Padrão: url

Nome do enum: ImagesResponseFormat

Valores de enumeração:

Valor	Descrição
url	A URL que oferece acesso temporário para baixar as imagens geradas.
b64_json	As imagens geradas são retornadas como strings codificadas em base64.

imageSize

O tamanho das imagens geradas.

Descrição: O tamanho das imagens geradas.

Tipo: cadeia de caracteres

Padrão: 1024x1024

Nome Enum: Tamanho

Valores de enumeração:

Valor	Descrição
1792x1024	O tamanho desejado da imagem gerada é 1792x1024 pixels.
1024x1792	O tamanho desejado da imagem gerada é 1024x1792 pixels.
1024x1024	O tamanho desejado da imagem gerada é 1024x1024 pixels.

imageStyle

O estilo das imagens geradas.

Descrição: O estilo das imagens geradas.

Tipo: cadeia de caracteres

Padrão: vívido

Nome Enum: Style

Valores de enumeração:

Valor	Descrição
Vívido	Vivid cria imagens hiper-realistas e dramáticas.
natural	Natural cria imagens mais naturais e menos hiper-realistas.

imageGenerationsRequest

Nome	Tipo	Descrição	Obrigatório	Default
solicitação	cadeia	Uma descrição em texto da(s) imagem(s) desejada(s). O comprimento máximo é de 4.000 caracteres.	Yes
n	inteiro	O número de imagens a serem geradas.	No	1
size	imageSize	O tamanho das imagens geradas.	No	1024x1024
formato_de_resposta	imagesResponseFormat	O formato no qual as imagens geradas são retornadas.	No	url
usuário	cadeia	Um identificador único representando seu usuário final, que pode ajudar a monitorar e detectar abusos.	No
Qualidade	imageQuality	A qualidade da imagem que será gerada.	No	padrão
estilo	imageStyle	O estilo das imagens geradas.	No	Vívido

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

imageResult

A URL da imagem ou imagem codificada se for bem-sucedida, e um erro caso contrário.

Nome	Tipo	Descrição	Obrigatório
url	cadeia	A URL da imagem.	No
b64_json	cadeia	A imagem codificada base64	No
content_filter_results	dalleContentFilterResults	Informações sobre os resultados do filtro de conteúdo.	No
revised_prompt	cadeia	O prompt usado para gerar a imagem, caso houvesse alguma revisão no prompt.	No
prompt_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

Extensões de conclusão

Extensões de completions não fazem parte da versão mais recente de GA da especificação de inferência do plano de dados do Azure OpenAI.

Mensagem de Chat

O objeto de mensagem Chat não faz parte da versão mais recente de GA da especificação de inferência do plano de dados do Azure OpenAI.

Texto para fala (Prévia)

Atualmente, não faz parte da versão mais recente Azure OpenAI GA da especificação de inferência de planos de dados do Open Azure AI. Consulte a versão mais recente prévia para essa capacidade.

Próximas Etapas

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

Comentários

Esta página foi útil?

Last updated on 2026-05-20