Azure OpenAI chat

Versão da API: v1

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

Variáveis de servidor:

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

Authentication

ApiKeyAuth (API Key)

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

ApiKeyAuth_ (Chave API)

Passe sua chave de API no authorization cabeçalho.

OAuth2Auth (OAuth 2.0)

Fluxo: implícito

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

Escopos:

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

Requisitos de segurança

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

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

Criar conclusão de chat

POST {endpoint}/openai/v1/chat/completions

Cria uma conclusão de chat.

Parâmetros de URI

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

Corpo da solicitação

Tipo de conteúdo: application/json

Nome Tipo Description Obrigatório Default
audio OpenAI.CreateChatCompletionRequestAudio ou nulo Parâmetros para saída de áudio. Necessário quando a saída de áudio é solicitada com
modalities: ["audio"].		 No
frequency_penalty número ou nulo Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em
sua frequência existente no texto até agora, diminuindo a do modelo
probabilidade de repetir a mesma linha verbatim.
Restrições: mínimo: -2, máximo: 2		 No
function_call string ou OpenAI.ChatCompletionFunctionCallOption (obsoleto) Preterido em favor de tool_choice.
Controla qual função (se houver) é chamada pelo modelo.
none significa que o modelo não chamará uma função e, em vez disso, gerará uma
mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar um
Função.
Especificar uma função específica por meio {"name": "my_function"} de força o
modelo para 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 array de OpenAI.ChatCompletionFunctions (obsoleto) Preterido em favor de tools.
Uma lista de funções para as quais o modelo pode gerar entradas JSON.
Restrições: mínimosItens: 1, máximoItens: 128		 No
logit_bias objeto ou nulo Modifique a probabilidade de tokens especificados aparecerem na conclusão.
Aceita um objeto JSON que mapeia tokens (especificados por sua ID de token no
tokenizer) para um valor de desvio associado de -100 a 100. Matematicamente
o desvio é adicionado aos logits gerados pelo modelo antes da amostragem.
O efeito exato variará por modelo, mas os valores entre -1 e 1 devem
diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100
deve resultar em uma proibição ou seleção exclusiva do token relevante.		 No
logprobs booliano ou nulo Se deseja retornar probabilidades de log dos tokens de saída ou não. Se for verdade,
retorna as probabilidades de log de cada token de saída retornado no
content de message.		 No
max_completion_tokens inteiro ou nulo 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
número máximo de tokens inteiro ou nulo (obsoleto) O número máximo de tokens que podem ser gerados na conclusão do chat.
Esse valor pode ser usado para controlar os custos do texto gerado por meio da API.

Esse valor agora foi preterido em favor de max_completion_tokens, e é
não compatível com modelos da série o1.		 No
messages matriz de OpenAI.ChatCompletionRequestMessage Uma lista de mensagens que compõem a conversa até agora. Dependendo do
modelo usado, diferentes tipos de mensagem (modalidades) têm suporte,
como texto, imagens e áudio.
Restrições: minItens: 1		 Yes
metadados OpenAI.Metadata ou nulo No
Modalidades OpenAI.ResponseModalities Tipos de saída que você gostaria que o modelo gerasse.
A maioria dos modelos é capaz de gerar texto, que é o padrão:
["text"]
O gpt-4o-audio-preview modelo também pode ser usado para
Gerar áudio. Para solicitar que esse modelo gere
As respostas de texto e áudio podem ser usadas:
["text", "audio"]		 No
modelo cadeia ID do modelo usada para gerar a resposta, como gpt-4o ou o3. OpenAI
oferece uma ampla gama de modelos com diferentes funcionalidades, desempenho
características e pontos de preço. Consulte o guia de modelos
para navegar e comparar os modelos disponíveis.		 Yes
n inteiro ou nulo Quantas opções de conclusão de chat serão geradas para cada mensagem de entrada. Observe que você será cobrado com base no número de tokens gerados em todas as opções. Mantenha n como 1 minimizar os custos.
Restrições: mínimo: 1, máximo: 128		 No
parallel_tool_calls boolean Se deseja habilitar a chamada de função paralela durante o uso da ferramenta. No True
previsão OpenAI.PredictionContent ou null Configuração para uma saída prevista, que pode melhorar muito
tempos de resposta quando grandes partes da resposta do modelo são conhecidas
Antes do tempo. Isso é mais comum quando você está regenerando um
Arquivo com apenas pequenas alterações na maior parte do conteúdo.		 No
penalidade_de_presença número ou nulo Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em
se eles aparecem no texto até agora, aumentando a probabilidade do modelo
para falar sobre novos tópicos.
Restrições: mínimo: -2, máximo: 2		 No
prompt_cache_key cadeia Usado pelo OpenAI para armazenar em cache respostas para solicitações semelhantes para otimizar as taxas de ocorrência do cache. Substitui o user campo. No
prompt_cache_retention cadeia de caracteres ou nulo No
esforço de raciocínio Esforço de Raciocínio da OpenAI Restringe o esforço no raciocínio para
modelos de raciocínio.
Os valores com suporte no momento são none, , minimal, low, medium, highe xhigh. Reduzir
o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio em uma resposta.
- gpt-5.1 o padrão é none, que não executa o raciocínio. Os valores de raciocínio com suporte sãogpt-5.1, e nonelowmedium.high Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1.
- Todos os modelos antes gpt-5.1 do padrão para medium o esforço de raciocínio e não dão suporte none.
- O gpt-5-pro modelo usa como padrão o esforço de raciocínio (e só dá high suporte).
- xhigh há suporte para todos os modelos após gpt-5.1-codex-max.		 No
formato_de_resposta OpenAI.CreateChatCompletionRequestResponseFormat Um objeto que especifica o formato que o modelo deve gerar.
Configuração para { "type": "json_schema", "json_schema": {...} } habilitar
Saídas Estruturadas que garantem que o modelo corresponda ao JSON fornecido
Esquema. Saiba mais no
Definir para { "type": "json_object" } habilita o modo JSON mais antigo, que
garante que a mensagem gerada pelo modelo seja JSON válida. Usando json_schema
é preferencial para modelos que dão suporte a isso.		 No
└─ tipo OpenAI.CreateChatCompletionRequestResponseFormatType Yes
safety_identifier cadeia Um identificador estável usado para ajudar a detectar usuários do aplicativo que podem estar violando as políticas de uso do OpenAI.
Os IDs devem ser uma string que identifique unicamente cada usuário, com um comprimento máximo de 64 caracteres. Recomendamos o hash de seu nome de usuário ou endereço de email, a fim de evitar enviar-nos qualquer informação de identificação.
Restrições: maxComprimento: 64		 No
seed inteiro ou nulo (obsoleto) Esse recurso está em Beta.
Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que solicitações repetidas com o mesmo seed e parâmetros devem retornar o mesmo resultado.
O determinismo não é garantido e você deve se referir ao system_fingerprint parâmetro de resposta para monitorar as alterações no back-end.		 No
Parar OpenAI.StopConfiguration ou null No
armazenar booliano ou nulo Se deseja ou não armazenar a saída dessa solicitação de conclusão de chat para
usar em produtos de destilação ou avaliação de modelo.		 No
fluxo booliano ou nulo Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente
como ele é gerado usando eventos enviados pelo servidor.		 No
stream_options OpenAI.ChatCompletionStreamOptions ou nulo No
Temperatura número ou nulo No
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual ferramenta (se houver) é chamada pelo modelo.
none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará 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 por meio {"type": "function", "function": {"name": "my_function"}} de força o modelo a chamar essa ferramenta.
none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.		 No
tools matriz de OpenAI.ChatCompletionTool ou OpenAI.CustomToolChatCompletions Uma lista de ferramentas que o modelo pode chamar. Você pode fornecer qualquer um
Ferramentas personalizadas ou
Ferramentas funcionais.		 No
top_logprobs inteiro ou nulo No
top_p número ou nulo No
usuário cadeia de caracteres (preterida) Um identificador exclusivo que representa o usuário final, que pode ajudar a
monitorar e detectar abusos.		 No
user_security_context AzureUserSecurityContext O contexto de segurança do usuário contém vários parâmetros que descrevem o próprio aplicativo e o usuário final que interage com o aplicativo. Esses campos ajudam suas equipes de operações de segurança a investigar e mitigar incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Learn mais sobre como proteger aplicativos de IA usando Microsoft Defender para Nuvem. No
detalhamento OpenAI.Verbosity Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em
respostas mais concisas, enquanto valores mais altos resultarão em respostas mais detalhadas.
Os valores com suporte no momento são low, mediume high.		 No

Responses

Código de status: 200

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

Tipo de conteúdo Type Description
application/json objeto ou objeto

Cabeçalhos de resposta:

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo Type Description
application/json objeto
Nome Tipo Description Obrigatório Default
codificar cadeia de caracteres ou nulo Yes
inner_error No
mensagem cadeia Yes
param cadeia de caracteres ou nulo No
tipo cadeia No

Cabeçalhos de resposta:

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

Exemplos

Example

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

POST {endpoint}/openai/v1/chat/completions?api-version=latest&azure-beta=v1=preview

{
  "model": "gpt-4o-mini",
  "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

{
  "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? ..."
      }
    }
  ],
  "usage": {
    "completion_tokens": 557,
    "prompt_tokens": 33,
    "total_tokens": 590
  }
}

Components

AzureAIFoundryModelsApiVersion

Property Valor
Type cadeia
Valores v1
preview

AzureContentFilterBlocklistResult

Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas.

Nome Tipo Description Obrigatório Default
details matriz de objeto Os pares de IDs individuais da lista de bloqueio e se eles resultaram em ações de filtragem. No
Filtrada boolean Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem. Yes

AzureContentFilterCompletionTextSpan

Uma representação de um segmento de texto de conclusão, conforme usado pelos resultados do filtro de conteúdo do Azure OpenAI.

Nome Tipo Description Obrigatório Default
completion_end_offset inteiro (int32) Deslocamento do primeiro ponto de código UTF32 que é excluído do intervalo. Esse campo é sempre igual a completion_start_offset para intervalos vazios. Esse campo é sempre maior que completion_start_offset para intervalos não vazios. Yes
completion_start_offset inteiro (int32) Deslocamento do ponto de código UTF32 que inicia o intervalo. Yes

AzureContentFilterCompletionTextSpanDetectionResult

Nome Tipo Description Obrigatório Default
details matriz de AzureContentFilterCompletionTextSpan Informações detalhadas sobre os intervalos de texto de conclusão detectados. Yes
detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
Filtrada boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes

AzureContentFilterCustomTopicResult

Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados.

Nome Tipo Description Obrigatório Default
details matriz de objeto Os pares de IDs de tópico individuais e se são detectados. No
Filtrada boolean Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. Yes

AzureContentFilterDetectionResult

Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado.

Nome Tipo Description Obrigatório Default
detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
Filtrada boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes

AzureContentFilterPersonallyIdentifiableInformationResult

Um resultado de detecção de filtro de conteúdo para informações de identificação pessoal que inclui extensões de danos.

Nome Tipo Description Obrigatório Default
detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
Filtrada boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
redacted_text cadeia O texto redigido com informações de PII removidas ou mascaradas. No
sub_categories matriz de AzurePiiSubCategoryResult Resultados detalhados para PIIHarmSubCategory(s) individuais. No

AzureContentFilterResultForChoice

Um resultado de filtro de conteúdo para um único item de resposta produzido por um sistema de IA generativo.

Nome Tipo Description Obrigatório Default
custom_blocklists AzureContentFilterBlocklistResult Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas. No
└─ detalhes matriz de objeto Os pares de IDs individuais da lista de bloqueio e se eles resultaram em ações de filtragem. No
└─ filtrado boolean Um valor que indica se a lista de bloqueios produziu uma ação de filtragem. Yes
└─ id cadeia A ID da lista de bloqueios personalizada avaliada. Yes
└─ filtrado boolean Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem. Yes
custom_topics AzureContentFilterCustomTopicResult Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados. No
└─ detalhes matriz de objeto Os pares de IDs de tópico individuais e se são detectados. No
└─ detectado boolean Um valor que indica se o tópico foi detectado. Yes
└─ id cadeia A ID do tópico personalizado avaliado. Yes
└─ filtrado boolean Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. Yes
erro objeto Se estiver presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação. No
└─ código inteiro (int32) Um código distinto e legível pelo computador associado ao erro. Yes
Mensagem └─ cadeia Uma mensagem legível por humanos associada ao erro. Yes
Odeio AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
personally_identifiable_information AzureContentFilterPersonallyIdentifiableInformationResult Um resultado de detecção de filtro de conteúdo para informações de identificação pessoal que inclui extensões de danos. No
└─ redacted_text cadeia O texto redigido com informações de PII removidas ou mascaradas. No
└─ sub-categorias matriz de AzurePiiSubCategoryResult Resultados detalhados para PIIHarmSubCategory(s) individuais. No
Profanidade AzureContentFilterDetectionResult Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi
filtrado.		 No
└─ detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
└─ filtrado boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
protected_material_code objeto Um resultado de detecção que descreve uma correspondência com o código licenciado ou outro material de origem protegido. No
└─ citação objeto Se disponível, os detalhes da citação que descrevem a licença associada e sua localização. No
└─ URL cadeia de caracteres (uri) A URL associada à licença. No
└─ Licença cadeia O nome ou identificador da licença associada à detecção. No
└─ detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
└─ filtrado boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
protected_material_text AzureContentFilterDetectionResult Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi
filtrado.		 No
└─ detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
└─ filtrado boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
self_harm AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
sexual AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
Violência AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes

AzureContentFilterResultForPrompt

Um resultado de filtro de conteúdo associado a um único item de solicitação de entrada em um sistema de IA generativa.

Nome Tipo Description Obrigatório Default
content_filter_results objeto Os detalhes da categoria de filtro de conteúdo para o resultado. No
└─ listas_personalizadas_de_bloqueio AzureContentFilterBlocklistResult Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas. No
└─ detalhes matriz de objeto Os pares de IDs individuais da lista de bloqueio e se eles resultaram em ações de filtragem. No
└─ filtrado boolean Um valor que indica se a lista de bloqueios produziu uma ação de filtragem. Yes
└─ id cadeia A ID da lista de bloqueios personalizada avaliada. Yes
└─ filtrado boolean Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem. Yes
└─ tópicos_personalizados AzureContentFilterCustomTopicResult Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados. No
└─ detalhes matriz de objeto Os pares de IDs de tópico individuais e se são detectados. No
└─ detectado boolean Um valor que indica se o tópico foi detectado. Yes
└─ id cadeia A ID do tópico personalizado avaliado. Yes
└─ filtrado boolean Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. Yes
└─ erro objeto Se estiver presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação. No
└─ código inteiro (int32) Um código distinto e legível pelo computador associado ao erro. Yes
Mensagem └─ cadeia Uma mensagem legível por humanos associada ao erro. Yes
└─ ódio AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
└─ ataque_indireto AzureContentFilterDetectionResult Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi
filtrado.		 Yes
└─ detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
└─ filtrado boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ desbloqueio AzureContentFilterDetectionResult Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi
filtrado.		 Yes
└─ detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
└─ filtrado boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ palavrões AzureContentFilterDetectionResult Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi
filtrado.		 No
└─ detectado boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
└─ filtrado boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ automutilação AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
└─ sexual AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
└─ violência AzureContentFilterSeverityResult Um item rotulado de resultado de filtro de conteúdo que indica se o conteúdo foi filtrado e qual o resultado qualitativo.
O nível de severidade do conteúdo foi avaliado com base na configuração do filtro de conteúdo para a categoria.		 No
└─ filtrado boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
└─ severidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes
prompt_index inteiro (int32) O índice da solicitação de entrada associado às categorias de resultado do filtro de conteúdo que acompanham. No

AzureContentFilterSeverityResult

Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.

Nome Tipo Description Obrigatório Default
Filtrada boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
Gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 Yes

AzurePiiSubCategoryResult

Detalhes do resultado para PIIHarmSubCategory(s) individuais.

Nome Tipo Description Obrigatório Default
detectado boolean Se a subcategoria de conteúdo rotulada foi detectada no conteúdo. Yes
Filtrada boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo para essa subcategoria. Yes
Redigido boolean Se o conteúdo foi redigido para essa subcategoria. Yes
sub_category cadeia O PIIHarmSubCategory que foi avaliado. Yes

AzureUserSecurityContext

O contexto de segurança do usuário contém vários parâmetros que descrevem o próprio aplicativo e o usuário final que interage com o aplicativo. Esses campos ajudam suas equipes de operações de segurança a investigar e mitigar incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Learn mais sobre como proteger aplicativos de IA usando Microsoft Defender para Nuvem.

Nome Tipo Description Obrigatório Default
application_name cadeia O nome do aplicativo. Informações pessoais confidenciais não devem ser incluídas neste campo. No
end_user_id cadeia Esse identificador é a ID de objeto de usuário Microsoft Entra ID (anteriormente Azure Active Directory) usada para autenticar usuários finais no aplicativo de IA generativo. Informações pessoais confidenciais não devem ser incluídas neste campo. No
end_user_tenant_id cadeia O ID do tenant Microsoft 365 ao qual o usuário final pertence. Ele é necessário quando o aplicativo de IA generativa é multilocatário. No
source_ip cadeia Captura o endereço IP do cliente original. No

OpenAI.ChatCompletionAllowedTools

Ferramentas permitidas

Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.

Nome Tipo Description Obrigatório Default
mode enumeração Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.
auto permite que o modelo escolha entre as ferramentas permitidas e gere um
mensagem.
required requer que o modelo chame uma ou mais das ferramentas permitidas.
Valores possíveis: auto, required		 Yes
tools matriz de objeto Uma lista de definições de ferramentas que o modelo deve ter permissão para chamar.
Para a API de Conclusões de Chat, a lista de definições de ferramentas pode ser semelhante a:
json<br> [ { "type": "function", "function": { "name": "get_weather" } }, { "type": "function", "function": { "name": "get_time" } } ]<br> 		Yes

OpenAI.ChatCompletionAllowedToolsChoice

Ferramentas permitidas

Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido.

Nome Tipo Description Obrigatório Default
ferramentas_permitidas OpenAI.ChatCompletionAllowedTools Restringe as ferramentas disponíveis para o modelo a um conjunto predefinido. Yes
tipo enumeração Tipo de configuração de ferramenta permitido. Sempre allowed_tools.
Valores possíveis: allowed_tools		 Yes

OpenAI.ChatCompletionFunctionCallOption

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

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

OpenAI.ChatCompletionFunctions

Nome Tipo Description Obrigatório Default
description cadeia Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função. No
nome cadeia O nome da função a ser chamada. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
parameters OpenAI.FunctionParameters Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Veja 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

OpenAI.ChatCompletionMessageCustomToolCall

Chamada de ferramenta personalizada

Uma chamada para uma ferramenta personalizada criada pelo modelo.

Nome Tipo Description Obrigatório Default
Personalizado OpenAI.ChatCompletionMessageCustomToolCallCustom Yes
└─ entrada cadeia Yes
└─ nome cadeia Yes
id cadeia A ID da chamada da ferramenta. Yes
tipo enumeração O tipo da ferramenta. Sempre custom.
Valores possíveis: custom		 Yes

OpenAI.ChatCompletionMessageCustomToolCallCustom

Nome Tipo Description Obrigatório Default
entrada cadeia Yes
nome cadeia Yes

OpenAI.ChatCompletionMessageToolCall

Chamada de ferramenta de função

Uma chamada para uma ferramenta de função criada pelo modelo.

Nome Tipo Description Obrigatório Default
função OpenAI.ChatCompletionMessageToolCallFunction Yes
└─ Argumentos cadeia Yes
└─ nome cadeia Yes
id cadeia A ID da chamada da ferramenta. Yes
tipo enumeração O tipo da ferramenta. Atualmente, há suporte apenas para function.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Nome Tipo Description Obrigatório Default
função OpenAI.ChatCompletionMessageToolCallChunkFunction No
id cadeia A ID da chamada da ferramenta. No
indexar inteiro Yes
tipo enumeração O tipo da ferramenta. Atualmente, há suporte apenas para function.
Valores possíveis: function		 No

OpenAI.ChatCompletionMessageToolCallChunkFunction

Nome Tipo Description Obrigatório Default
arguments cadeia No
nome cadeia No

OpenAI.ChatCompletionMessageToolCallFunction

Nome Tipo Description Obrigatório Default
arguments cadeia Yes
nome cadeia Yes

OpenAI.ChatCompletionMessageToolCalls

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

OpenAI.ChatCompletionMessageToolCallsItem

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

OpenAI.ChatCompletionNamedToolChoice

Escolha da ferramenta funcional

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

Nome Tipo Description Obrigatório Default
função OpenAI.ChatCompletionNamedToolChoiceFunction Yes
tipo enumeração Para a chamada de função, o tipo é sempre function.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionNamedToolChoiceCustom

Escolha de ferramenta personalizada

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

Nome Tipo Description Obrigatório Default
Personalizado OpenAI.ChatCompletionNamedToolChoiceCustomCustom Yes
tipo enumeração Para chamada de ferramenta personalizada, o tipo é sempre custom.
Valores possíveis: custom		 Yes

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

Nome Tipo Description Obrigatório Default
nome cadeia Yes

OpenAI.ChatCompletionNamedToolChoiceFunction

Nome Tipo Description Obrigatório Default
nome cadeia Yes

OpenAI.ChatCompletionRequestAssistantMessage

Mensagem do assistente

Mensagens enviadas pelo modelo em resposta às mensagens do usuário.

Nome Tipo Description Obrigatório Default
audio OpenAI.ChatCompletionRequestAssistantMessageAudio ou null Dados sobre uma resposta de áudio anterior do modelo. No
conteúdo cadeia de caracteres ou matriz de OpenAI.ChatCompletionRequestAssistantMessageContentPart ou null No
function_call OpenAI.ChatCompletionRequestAssistantMessageFunctionCall ou null No
nome cadeia Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função. No
Recusa cadeia de caracteres ou nulo No
função enumeração A função do autor das mensagens, nesse caso assistant.
Valores possíveis: assistant		 Yes
tool_calls OpenAI.ChatCompletionMessageToolCalls As chamadas de ferramenta geradas pelo modelo, como chamadas de função. No

OpenAI.ChatCompletionRequestAssistantMessageAudio

Nome Tipo Description Obrigatório Default
id cadeia Yes

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestAssistantMessageContentPart

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Digite um valor Schema
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
text OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
Nome Tipo Description Obrigatório Default
tipo OpenAI.ChatCompletionRequestAssistantMessageContentPartType Yes

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Parte do conteúdo do texto

Nome Tipo Description Obrigatório Default
enviar SMS cadeia O conteúdo do texto. Yes
tipo enumeração O tipo da parte de conteúdo.
Valores possíveis: text		 Yes

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Property Valor
Type cadeia
Valores text
refusal

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

Nome Tipo Description Obrigatório Default
arguments cadeia Yes
nome cadeia Yes

OpenAI.ChatCompletionRequestDeveloperMessage

Mensagem do desenvolvedor

Instruções fornecidas pelo desenvolvedor que o modelo deve seguir, independentemente das mensagens enviadas pelo usuário. Com modelos o1 e mais recentes, developer as mensagens substituem as mensagens anteriores system .

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou matriz de OpenAI.ChatCompletionRequestMessageContentPartText O conteúdo da mensagem do desenvolvedor. Yes
nome cadeia Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função. No
função enumeração A função do autor das mensagens, nesse caso developer.
Valores possíveis: developer		 Yes

OpenAI.ChatCompletionRequestFunctionMessage

Mensagem de função

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou nulo Yes
nome cadeia O nome da função a ser chamada. Yes
função enumeração A função do autor das mensagens, nesse caso function.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionRequestMessage

Discriminador para OpenAI.ChatCompletionRequestMessage

Esse componente usa a propriedade role para discriminar entre diferentes tipos:

Digite um valor Schema
assistant OpenAI.ChatCompletionRequestAssistantMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
function OpenAI.ChatCompletionRequestFunctionMessage
system OpenAI.ChatCompletionRequestSystemMessage
user OpenAI.ChatCompletionRequestUserMessage
tool OpenAI.ChatCompletionRequestToolMessage
Nome Tipo Description Obrigatório Default
função OpenAI.ChatCompletionRequestMessageType Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Parte de conteúdo de áudio

Nome Tipo Description Obrigatório Default
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio Yes
tipo enumeração O tipo da parte de conteúdo. Sempre input_audio.
Valores possíveis: input_audio		 Yes

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio

Nome Tipo Description Obrigatório Default
dados cadeia Yes
format enumeração
Valores possíveis: wav, mp3		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Parte do conteúdo do arquivo

Nome Tipo Description Obrigatório Default
arquivo OpenAI.ChatCompletionRequestMessageContentPartFileFileFile Yes
tipo enumeração O tipo da parte de conteúdo. Sempre file.
Valores possíveis: file		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFileFileFile

Nome Tipo Description Obrigatório Default
file_data cadeia No
file_id cadeia No
filename cadeia No

OpenAI.ChatCompletionRequestMessageContentPartImage

Parte do conteúdo da imagem

Nome Tipo Description Obrigatório Default
image_url OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl Yes
tipo enumeração O tipo da parte de conteúdo.
Valores possíveis: image_url		 Yes

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

Nome Tipo Description Obrigatório Default
detail enumeração
Valores possíveis: auto, , lowhigh		 No automático
url cadeia de caracteres (uri) Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Parte do conteúdo de recusa

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

OpenAI.ChatCompletionRequestMessageContentPartText

Parte do conteúdo do texto

Nome Tipo Description Obrigatório Default
enviar SMS cadeia O conteúdo do texto. Yes
tipo enumeração O tipo da parte de conteúdo.
Valores possíveis: text		 Yes

OpenAI.ChatCompletionRequestMessageType

Property Valor
Type cadeia
Valores developer
system
user
assistant
tool
function

OpenAI.ChatCompletionRequestSystemMessage

Mensagem do sistema

Instruções fornecidas pelo desenvolvedor que o modelo deve seguir, independentemente das mensagens enviadas pelo usuário. Com modelos o1 e mais recentes, use mensagens de developer para essa finalidade.

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou matriz de OpenAI.ChatCompletionRequestSystemMessageContentPart O conteúdo da mensagem do sistema. Yes
nome cadeia Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função. No
função enumeração A função do autor das mensagens, nesse caso system.
Valores possíveis: system		 Yes

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referências: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Mensagem da ferramenta

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou matriz de OpenAI.ChatCompletionRequestToolMessageContentPart O conteúdo da mensagem da ferramenta. Yes
função enumeração A função do autor das mensagens, nesse caso tool.
Valores possíveis: tool		 Yes
tool_call_id cadeia Chamada de ferramenta à qual esta mensagem está respondendo. Yes

OpenAI.ChatCompletionRequestToolMessageContentPart

Referências: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Mensagem do usuário

Mensagens enviadas por um usuário final, contendo prompts ou informações de contexto adicionais.

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou matriz de OpenAI.ChatCompletionRequestUserMessageContentPart O conteúdo da mensagem do usuário. Yes
nome cadeia Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função. No
função enumeração A função do autor das mensagens, nesse caso user.
Valores possíveis: user		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestUserMessageContentPart

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Digite um valor Schema
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
file OpenAI.ChatCompletionRequestMessageContentPartFile
text OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText
Nome Tipo Description Obrigatório Default
tipo OpenAI.ChatCompletionRequestUserMessageContentPartType Yes

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Parte do conteúdo do texto

Nome Tipo Description Obrigatório Default
enviar SMS cadeia O conteúdo do texto. Yes
tipo enumeração O tipo da parte de conteúdo.
Valores possíveis: text		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPartType

Property Valor
Type cadeia
Valores text
image_url
input_audio
file

OpenAI.ChatCompletionResponseMessage

Se a modalidade de saída de áudio for solicitada, esse objeto conterá dados sobre a resposta de áudio do modelo.

Nome Tipo Description Obrigatório Default
annotations matriz de OpenAI.ChatCompletionResponseMessageAnnotations Anotações para a mensagem, quando aplicável, como ao usar o
Ferramenta de pesquisa na Web.		 No
audio OpenAI.ChatCompletionResponseMessageAudio ou null No
conteúdo cadeia de caracteres ou nulo Yes
function_call OpenAI.ChatCompletionResponseMessageFunctionCall (obsoleto) No
└─ Argumentos cadeia Yes
└─ nome cadeia Yes
reasoning_content cadeia Uma propriedade de extensão específica do Azure que contém conteúdo de raciocínio gerado a partir de modelos compatíveis. No
Recusa cadeia de caracteres ou nulo Yes
função enumeração A função do autor desta mensagem.
Valores possíveis: assistant		 Yes
tool_calls OpenAI.ChatCompletionMessageToolCallsItem As chamadas de ferramenta geradas pelo modelo, como chamadas de função. No

OpenAI.ChatCompletionResponseMessageAnnotations

Nome Tipo Description Obrigatório Default
tipo enumeração
Valores possíveis: url_citation		 Yes
url_citation OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation Yes

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

Nome Tipo Description Obrigatório Default
end_index inteiro Yes
start_index inteiro Yes
title cadeia Yes
url cadeia de caracteres (uri) Yes

OpenAI.ChatCompletionResponseMessageAudio

Nome Tipo Description Obrigatório Default
dados cadeia Yes
expira_em inteiro (unixtime) Yes
id cadeia Yes
transcrição cadeia Yes

OpenAI.ChatCompletionResponseMessageFunctionCall

Nome Tipo Description Obrigatório Default
arguments cadeia Yes
nome cadeia Yes

OpenAI.ChatCompletionStreamOptions

Opções para resposta de streaming. Defina isso somente quando você definir stream: true.

Nome Tipo Description Obrigatório Default
include_obfuscation boolean Quando true, a ofuscação de fluxo será habilitada. Adiciones de ofuscação de fluxo
caracteres aleatórios para um obfuscation campo em eventos delta de streaming para
normalize os tamanhos de carga como uma mitigação para determinados ataques de canal lateral.
Esses campos de ofuscação são incluídos por padrão, mas adicionam uma pequena quantidade
de sobrecarga para o fluxo de dados. Você pode definir include_obfuscation como
false para otimizar para largura de banda se você confiar nos links de rede entre
seu aplicativo e a API OpenAI.		 No
include_usage boolean Se definido, uma parte adicional será transmitida antes do data: [DONE]
mensagem. O usage campo nesta parte mostra as estatísticas de uso do token
para toda a solicitação, e o choices campo sempre será um vazio
matriz.
Todas as outras partes também incluirão um usage campo, mas com um valor nulo
Valor. NOTA: Se o fluxo for interrompido, você poderá não receber o
parte de uso final que contém o uso total do token para a solicitação.		 No

OpenAI.ChatCompletionStreamResponseDelta

Um delta de conclusão de chat gerado por respostas de modelo transmitidas.

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou nulo No
function_call OpenAI.ChatCompletionStreamResponseDeltaFunctionCall (obsoleto) No
└─ Argumentos cadeia No
└─ nome cadeia No
reasoning_content cadeia Uma propriedade de extensão específica do Azure que contém conteúdo de raciocínio gerado a partir de modelos compatíveis. No
Recusa cadeia de caracteres ou nulo No
função enumeração A função do autor desta mensagem.
Valores possíveis: developer, , system, user, assistant, tool		 No
tool_calls matriz de OpenAI.ChatCompletionMessageToolCallChunk No

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

Nome Tipo Description Obrigatório Default
arguments cadeia No
nome cadeia No

OpenAI.ChatCompletionTokenLogprob

Nome Tipo Description Obrigatório Default
bytes matriz de inteiro ou nulo Yes
logprob número A probabilidade de log desse token, se ele estiver dentro dos 20 tokens mais prováveis. Caso contrário, o valor -9999.0 é usado para significar que o token é muito improvável. Yes
símbolo cadeia O token. Yes
top_logprobs matriz de OpenAI.ChatCompletionTokenLogprobTopLogprobs Lista dos tokens mais prováveis e sua probabilidade de log, nessa posição de token. O número de entradas pode ser menor que o solicitado top_logprobs. Yes

OpenAI.ChatCompletionTokenLogprobTopLogprobs

Nome Tipo Description Obrigatório Default
bytes matriz de inteiro ou nulo Yes
logprob número Yes
símbolo cadeia Yes

Ferramenta de Conclusão de Chat da OpenAI

Ferramenta de função

Uma ferramenta de função que pode ser usada para gerar uma resposta.

Nome Tipo Description Obrigatório Default
função OpenAI.FunctionObject Yes
tipo enumeração O tipo da ferramenta. Atualmente, há suporte apenas para function.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionToolChoiceOption

Controla qual ferramenta (se houver) é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará 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 por meio {"type": "function", "function": {"name": "my_function"}} de força o modelo a chamar essa ferramenta. none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.

Esse componente pode ser um dos seguintes:

OpenAI.CompletionUsage

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

Nome Tipo Description Obrigatório Default
completion_tokens inteiro Número de tokens na conclusão gerada. Yes
completion_tokens_details OpenAI.CompletionUsageCompletionTokensDetails No
└─ tokens_de_predição_aceitos inteiro No
└─ audio_tokens inteiro No
└─ tokens_de_raciocínio inteiro No
└─ tokens_de_predição_rejeitados inteiro No
prompt_tokens inteiro Número de tokens no prompt. Yes
prompt_tokens_details OpenAI.CompletionUsagePromptTokensDetails No
└─ audio_tokens inteiro No
└─ tokens em cache inteiro No
total_tokens inteiro Número total de tokens usados na solicitação (prompt + conclusão). Yes

OpenAI.CompletionUsageCompletionTokensDetails

Nome Tipo Description Obrigatório Default
accepted_prediction_tokens inteiro No
audio_tokens inteiro No
reasoning_tokens inteiro No
rejected_prediction_tokens inteiro No

OpenAI.CompletionUsagePromptTokensDetails

Nome Tipo Description Obrigatório Default
audio_tokens inteiro No
cached_tokens inteiro No

OpenAI.CreateChatCompletionRequestAudio

Nome Tipo Description Obrigatório Default
format enumeração
Valores possíveis: wav, , aac, mp3, flac, , opuspcm16		 Yes
Voz OpenAI.VoiceIdsOuCustomVoice Um nome de voz embutido ou uma referência de voz personalizada. Yes

OpenAI.CreateChatCompletionRequestResponseFormat

Um objeto que especifica o formato que o modelo deve gerar. A configuração para { "type": "json_schema", "json_schema": {...} } habilitar saídas estruturadas que garantem que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia Saídas Estruturadas. A configuração para { "type": "json_object" } habilita o modo JSON antigo, garantindo que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferencial para modelos que dão suporte a ele.

Discriminador para OpenAI.CreateChatCompletionRequestResponseFormat

Esse componente usa a propriedade type para discriminar entre diferentes tipos:

Digite um valor Schema
json_schema OpenAI.ResponseFormatJsonSchema
text OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
Nome Tipo Description Obrigatório Default
tipo OpenAI.CreateChatCompletionRequestResponseFormatType Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Objeto JSON

Formato de resposta de objeto JSON. Um método mais antigo de geração de respostas JSON. O uso json_schema é recomendado para modelos que dão suporte a ele. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazer isso.

Nome Tipo Description Obrigatório Default
tipo enumeração O tipo de formato de resposta que está sendo definido. Sempre json_object.
Valores possíveis: json_object		 Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Text

Formato de resposta padrão. Usado para gerar respostas de texto.

Nome Tipo Description Obrigatório Default
tipo enumeração O tipo de formato de resposta que está sendo definido. Sempre text.
Valores possíveis: text		 Yes

OpenAI.CreateChatCompletionRequestResponseFormatType

Property Valor
Type cadeia
Valores text
json_schema
json_object

OpenAI.CreateChatCompletionResponseChoices

Nome Tipo Description Obrigatório Default
content_filter_results AzureContentFilterResultForChoice Um resultado de filtro de conteúdo para um único item de resposta produzido por um sistema de IA generativo. No
motivo_de_conclusão enumeração
Valores possíveis: stop, , length, tool_calls, content_filter, function_call		 Yes
indexar inteiro Yes
logprobs OpenAI.CreateChatCompletionResponseChoicesLogprobs ou null Yes
mensagem OpenAI.ChatCompletionResponseMessage Se a modalidade de saída de áudio for solicitada, esse objeto conterá dados
sobre a resposta de áudio do modelo.		 Yes

OpenAI.CreateChatCompletionResponseChoicesLogprobs

Nome Tipo Description Obrigatório Default
conteúdo matriz de OpenAI.ChatCompletionTokenLogprob ou null Yes
Recusa matriz de OpenAI.ChatCompletionTokenLogprob ou null Yes

OpenAI.CreateChatCompletionStreamResponseChoices

Nome Tipo Description Obrigatório Default
delta OpenAI.ChatCompletionStreamResponseDelta Um delta de conclusão de chat gerado por respostas de modelo transmitidas. Yes
motivo_de_conclusão cadeia de caracteres ou nulo Yes
indexar inteiro Yes
logprobs OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs ou null No

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

Nome Tipo Description Obrigatório Default
conteúdo matriz de OpenAI.ChatCompletionTokenLogprob ou null Yes
Recusa matriz de OpenAI.ChatCompletionTokenLogprob ou null Yes

OpenAI.CustomToolChatCompletions

Ferramenta personalizada

Uma ferramenta personalizada que processa a entrada usando um formato especificado.

Nome Tipo Description Obrigatório Default
Personalizado OpenAI.CustomToolChatCompletionsCustom Yes
└─ descrição cadeia No
└─ Formato OpenAI.CustomToolChatCompletionsCustomFormatText ou OpenAI.CustomToolChatCompletionsCustomFormatGrammar No
└─ nome cadeia Yes
tipo enumeração O tipo da ferramenta personalizada. Sempre custom.
Valores possíveis: custom		 Yes

OpenAI.CustomToolChatCompletionsCustom

Nome Tipo Description Obrigatório Default
description cadeia No
format OpenAI.CustomToolChatCompletionsCustomFormatText ou OpenAI.CustomToolChatCompletionsCustomFormatGrammar No
nome cadeia Yes

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

Nome Tipo Description Obrigatório Default
Gramática OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammarmar Yes
└─ definição cadeia Yes
└─ sintaxe enumeração
Valores possíveis: lark, regex		 Yes
tipo enumeração
Valores possíveis: grammar		 Yes

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammarmar

Nome Tipo Description Obrigatório Default
definição cadeia Yes
Sintaxe enumeração
Valores possíveis: lark, regex		 Yes

OpenAI.CustomToolChatCompletionsCustomFormatText

Nome Tipo Description Obrigatório Default
tipo enumeração
Valores possíveis: text		 Yes

OpenAI.FunctionObject

Nome Tipo Description Obrigatório Default
description cadeia Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função. No
nome cadeia O nome da função a ser chamada. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
parameters OpenAI.FunctionParameters Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Veja 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 booliano ou nulo No

OpenAI.FunctionParameters

Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. Veja 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.

Tipo: objeto

OpenAI.Metadata

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.

Tipo: objeto

OpenAI.PredictionContent

Conteúdo estático

Conteúdo de saída previsto estático, como o conteúdo de um arquivo de texto que está sendo regenerado.

Nome Tipo Description Obrigatório Default
conteúdo cadeia de caracteres ou matriz de OpenAI.ChatCompletionRequestMessageContentPartText O conteúdo que deve ser correspondido ao gerar uma resposta de modelo.
Se os tokens gerados corresponderem a esse conteúdo, toda a resposta do modelo
pode ser retornado muito mais rapidamente.		 Yes
tipo enumeração O tipo do conteúdo previsto que você deseja fornecer. Esse tipo é
atualmente sempre de content.
Valores possíveis: content		 Yes

Esforço de Raciocínio da OpenAI

Limita o esforço de raciocínio em modelos de raciocínio. Os valores com suporte no momento são none, , minimal, low, medium, highe xhigh. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

  • gpt-5.1 o padrão é none, que não executa o raciocínio. Os valores de raciocínio com suporte sãogpt-5.1, e nonelowmedium.high Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1.
  • Todos os modelos antes gpt-5.1 do padrão para medium o esforço de raciocínio e não dão suporte none.
  • O gpt-5-pro modelo usa como padrão o esforço de raciocínio (e só dá high suporte).
  • xhigh há suporte para todos os modelos após gpt-5.1-codex-max.
Property Valor
Description Restringe o esforço no raciocínio para
modelos de raciocínio.
Os valores com suporte no momento são none, , minimal, low, medium, highe xhigh. Reduzir
o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio em uma resposta.
- gpt-5.1 o padrão é none, que não executa o raciocínio. Os valores de raciocínio com suporte sãogpt-5.1, e nonelowmedium.high Há suporte para chamadas de ferramenta para todos os valores de raciocínio no gpt-5.1.
- Todos os modelos antes gpt-5.1 do padrão para medium o esforço de raciocínio e não dão suporte none.
- O gpt-5-pro modelo usa como padrão o esforço de raciocínio (e só dá high suporte).
- xhigh há suporte para todos os modelos após gpt-5.1-codex-max.
Type cadeia
Valores none
minimal
low
medium
high
xhigh

OpenAI.ResponseFormatJsonSchema

Esquema JSON

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas.

Nome Tipo Description Obrigatório Default
json_schema OpenAI.ResponseFormatJsonSchemaJsonSchema Yes
└─ descrição cadeia No
└─ nome cadeia Yes
└─ esquema OpenAI.ResponseFormatJsonSchemaSchema O esquema para o formato de resposta, descrito como um objeto de esquema JSON.
Saiba como criar esquemas JSON aqui.		 No
└─ rigoroso booliano ou nulo No
tipo enumeração O tipo de formato de resposta que está sendo definido. Sempre json_schema.
Valores possíveis: json_schema		 Yes

OpenAI.ResponseFormatJsonSchemaJsonSchema

Nome Tipo Description Obrigatório Default
description cadeia No
nome cadeia Yes
esquema OpenAI.ResponseFormatJsonSchemaSchema O esquema para o formato de resposta, descrito como um objeto de esquema JSON.
Saiba como criar esquemas JSON aqui.		 No
rigoroso booliano ou nulo No

OpenAI.ResponseFormatJsonSchemaSchema

Esquema JSON

O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.

Tipo: objeto

OpenAI.ResponseModalities

Tipos de saída que você gostaria que o modelo gerasse. A maioria dos modelos é capaz de gerar texto, que é o padrão: ["text"] O gpt-4o-audio-preview modelo também pode ser usado para gerar áudio. Para solicitar que esse modelo gere respostas de texto e áudio, você pode usar: ["text", "audio"]

Esse esquema aceita um dos seguintes tipos:

  • array
  • zero

OpenAI.StopConfiguration

Modelos de raciocínio mais recentes o3 e o4-mini não são suportados. Até 4 sequências em que a API deixará de gerar tokens adicionais. O texto retornado não conterá a sequência de interrupção.

Esse componente pode ser um dos seguintes:

  • string
  • array

OpenAI.Verbosity

Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em respostas mais concisas, enquanto valores mais altos resultarão em respostas mais detalhadas. Os valores com suporte no momento são low, mediume high.

Property Valor
Description Restringe a verbosidade da resposta do modelo. Valores mais baixos resultarão em
respostas mais concisas, enquanto valores mais altos resultarão em respostas mais detalhadas.
Os valores com suporte no momento são low, mediume high.
Type cadeia
Valores low
medium
high

OpenAI.VoiceIdsOuCustomVoice

Voz

Um nome de voz embutido ou uma referência de voz personalizada.

Tipo: OpenAI.VoiceIdsShared ou objeto

Um nome de voz embutido ou uma referência de voz personalizada.

OpenAI.VoiceIdsShared

Property Valor
Type cadeia
Valores alloy
ash
ballad
coral
echo
sage
shimmer
verse
marin
cedar
  • Last updated on