Referência da API REST do Azure OpenAI no Microsoft Foundry Models v1

Atualmente, há suporte para apenas um subconjunto de operações com a API v1. Para saber mais, consulte o guia de ciclo de vida da versão da API.

Especificação do OpenAPI 3.0 v1

Criar conclusão de chat

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

Cria uma conclusão de chat.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Microsoft Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Padrão
audio	objeto	Parâmetros para saída de áudio. Necessário quando a saída de áudio é solicitada com `modalities: ["audio"]`.	Não
└─ formato	enumeração	Especifica o formato do áudio de saída. Deve ser um dos seguintes: `wav`, `mp3`, `flac` `opus` ou `pcm16`. Valores possíveis: `wav`, , `aac`, `mp3`, `flac`, , `opuspcm16`	Não
└─ voz	objeto		Não
data_sources	matriz	As fontes de dados a serem usadas para o recurso On Your Data, exclusivo do OpenAI do Azure.	Não
frequency_penalty	número	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.	Não	0
function_call	enumeração	Especificar uma determinada função por meio de `{"name": "my_function"}` força o modelo a chamar essa função. Valores possíveis: `none`, `auto`	Não
functions	matriz	Preterido em favor de `tools`. Uma lista de funções para as quais o modelo pode gerar entradas JSON.	Não
logit_bias	objeto	Modifica a probabilidade de tokens especificados que 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.	Não	Nenhum
logprobs	boolean	Se você quer retornar as probabilidades de log dos tokens de saída ou não. Se verdadeiro, retorna as probabilidades de log de cada token de saída retornado no `content` de `message`.	Não	Falso
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.	Não
número máximo de tokens	inteiro	O número máximo de tokens que podem ser gerados na conclusão. 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.	Não
messages	matriz	Uma lista de mensagens que resumem a conversa até agora. Dependendo do modelo usado, diferentes tipos de mensagem (modalidades) têm suporte, como texto, imagens e áudio.	Yes
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modalidades	objeto	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 modelo `gpt-4o-audio-preview` 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"]`	Não
modelo	cadeia	O identificador de implantação de modelo a ser usado para a solicitação de conclusão do chat.	Yes
n	inteiro	Quantas opções de preenchimento 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` para minimizar os custos.	Não	1
parallel_tool_calls	objeto	Se deseja habilitar a chamada de função paralela durante o uso da ferramenta.	Não
previsão	objeto	Representação base da saída prevista de um modelo.	Não
└─ tipo	OpenAI.ChatOutputPredictionType		Não
penalidade_de_presença	número	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.	Não	0
esforço de raciocínio	objeto	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
formato_de_resposta	objeto		Não
└─ tipo	enumeração	Valores possíveis: `text`, , `json_objectjson_schema`	Não
semente	inteiro	Esse recurso está em Versão Beta. Se especificado, nosso sistema fará o melhor esforço para amostrar de forma determinística, de modo que solicitações repetidas com os mesmos `seed` e os parâmetros retornem o mesmo resultado. O determinismo não é garantido e você deve consultar o parâmetro de resposta `system_fingerprint` para monitorar alterações no backend.	Não
parar	objeto	Não há suporte para modelos de raciocínio `o3` e `o4-mini`mais recentes. Até quatro sequências nas quais a API irá parar de gerar tokens. O O texto retornado não conterá a sequência de interrupção.	Não
armazenar	boolean	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.	Não	Falso
fluxo	boolean	Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor.	Não	Falso
stream_options	objeto	Opções para resposta de streaming. Defina isso somente quando você definir `stream: true`.	Não
└─ include_usage	boolean	Se definido, uma parte adicional será transmitida antes da `data: [DONE]` mensagem. O campo `usage` nesta parte mostra as estatísticas de uso do token para toda a solicitação, e o campo `choices` sempre será uma vazia matriz. Todas as outras partes também incluirão um campo `usage`, mas com um nulo valor. OBSERVAÇÃO: Se o fluxo for interrompido, você poderá não receber a parte de uso final que contém o uso total do token para a solicitação.	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não	1
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 determinada ferramenta por meio de `{"type": "function", "function": {"name": "my_function"}}` força o modelo a chamar essa ferramenta. `none` é o padrão quando não há nenhuma ferramenta presente. `auto` é o padrão se ferramentas estiverem presente.	Não
Ferramentas	matriz	Uma lista de ferramentas que o modelo pode chamar. No momento, há suporte apenas para funções como uma ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. Há suporte para um máximo de 128 funções.	Não
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 de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não	1
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar a monitorar e detectar abusos.	Não
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 os incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Saiba mais sobre como proteger aplicativos de IA usando o Microsoft Defender para Nuvem.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Exemplos

Exemplo

Cria uma conclusão para a solicitação fornecida, parâmetros e o modelo escolhido.

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

{
 "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

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

Criar inserção

POST {endpoint}/openai/v1/embeddings

Cria um vetor de inserção que representa o texto de entrada.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
dimensions	inteiro	O número de dimensões que as inserções de saída resultantes devem ter. Só há suporte em modelos `text-embedding-3` e posteriores.	Não
encoding_format	enumeração	O formato no qual as inserções devem ser retornadas. Pode ser um `float` ou `base64`. Valores possíveis: `float`, `base64`	Não
entrada	cadeia de caracteres ou matriz		Yes
modelo	cadeia	O modelo a ser usado para a solicitação de inserção.	Yes
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.CreateEmbeddingResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Exemplos

Exemplo

Retorne as inserções para um determinado prompt.

POST {endpoint}/openai/v1/embeddings

{
 "model": "text-embedding-ada-002",
 "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,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Listar valores

GET {endpoint}/openai/v1/evals

Liste as avaliações de um projeto.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
after	consulta	Não	cadeia	Identificador da última avaliação da solicitação de paginação anterior.
limite	consulta	Não	inteiro	Um limite no número de avaliações a serem retornados em uma única resposta de paginação.
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`	Ordem de classificação das avaliações por carimbo de data/hora. Usar `asc` como ordem crescente ou `desc` como ordem decrescente.
ordenar_por	consulta	Não	cadeia Valores possíveis: `created_at`, `updated_at`	Os valores podem ser ordenados por hora de criação ou hora da última atualização. Utilização `created_at` como a hora de criação ou `updated_at` como a última atualização Hora.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar avaliação

POST {endpoint}/openai/v1/evals

Crie a estrutura de uma avaliação que pode ser usada para testar o desempenho de um modelo.

Uma avaliação é um conjunto de critérios de teste e uma fonte de dados. Depois de criar uma avaliação, você pode executá-la em diferentes modelos e parâmetros de modelo. Oferecemos suporte a vários tipos de grades e fontes de dados.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
configuração_da_fonte_de_dados	objeto		Yes
└─ tipo	OpenAI.EvalDataSourceConfigType		Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da avaliação.	Não
statusCode	enumeração	Valores possíveis: `201`	Yes
critérios_de_teste	matriz	Uma lista de avaliadores para todas as execuções de avaliação neste grupo. Os avaliadores podem fazer referência a variáveis na fonte de dados usando a notação de chaves duplas, como `{{item.variable_name}}`. Para referenciar a saída do modelo, use o namespace `sample` (ou seja, `{{sample.output_text}}`).	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.Eval

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter avaliação

GET {endpoint}/openai/v1/evals/{eval_id}

Recupere uma avaliação por sua ID. Recupera uma avaliação por sua ID.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.Eval

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Atualizar a avaliação

POST {endpoint}/openai/v1/evals/{eval_id}

Atualize as propriedades selecionáveis e mutáveis de uma avaliação especificada.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Padrão
metadados	OpenAI.MetadataPropertyForRequest	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia		Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.Eval

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Excluir a avaliação

DELETE {endpoint}/openai/v1/evals/{eval_id}

Exclua uma avaliação especificada.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter execuções de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs

Recupere uma lista de execuções para uma avaliação especificada.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia
after	consulta	Não	cadeia
limite	consulta	Não	inteiro
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`
status	consulta	Não	cadeia Valores possíveis: `queued`, , `in_progress`, `completed`, `canceled`, `failed`

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalRunList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar execução de avaliação

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Crie uma nova execução de avaliação, iniciando o processo de classificação.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
fonte_de_dados	objeto		Yes
└─ tipo	OpenAI.EvalRunDataSourceType		Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da execução.	Não

Respostas

Código de status: 201

Descrição: a solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Recupere uma avaliação específica executada por sua ID.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Cancelar execução de avaliação

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Cancele uma avaliação específica executada por sua ID.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Excluir execução de avaliação

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Exclua uma avaliação específica executada por sua ID.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter itens de saída de execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Obtenha uma lista de itens de saída para uma execução de avaliação especificada.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia
after	consulta	Não	cadeia
limite	consulta	Não	inteiro
status	consulta	Não	cadeia Valores possíveis: `fail`, `pass`
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalRunOutputItemList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter item de saída de execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Recupere um item de saída específico de uma avaliação executada por sua ID.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-evals	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso ao AOAI Evals, um recurso de versão prévia do recurso. Esse recurso requer que o cabeçalho “aoai-evals” seja definido como “preview”.
eval_id	caminho	Yes	cadeia
run_id	caminho	Yes	cadeia
output_item_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.EvalRunOutputItem

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar arquivo

POST {endpoint}/openai/v1/files

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Content-Type: multipart/form-data

Nome	Tipo	Descrição	Obrigatório
expires_after	objeto		Yes
└─ âncora	AzureFileExpiryAnchor		Não
└─ segundos	inteiro		Não
arquivo	cadeia		Yes
purpose	enumeração	A finalidade pretendida do arquivo carregado. Um de: - `assistants`: usado na API de Assistentes - `batch`: usado na API do Lote - `fine-tune`: usado para ajuste fino - `evals`: usado nos conjuntos de dados de avaliação Valores possíveis: `assistants`, , `batch`, `fine-tuneevals`	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureOpenAIFile

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Exemplos

Exemplo

POST {endpoint}/openai/v1/files

Listar arquivos

GET {endpoint}/openai/v1/files

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
purpose	consulta	Não	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureListFilesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Recuperar o arquivo

GET {endpoint}/openai/v1/files/{file_id}

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
file_id	caminho	Yes	cadeia	A ID do arquivo a ser usado nessa solicitação.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureOpenAIFile

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Excluir arquivo

DELETE {endpoint}/openai/v1/files/{file_id}

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
file_id	caminho	Yes	cadeia	A ID do arquivo a ser usado nessa solicitação.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.DeleteFileResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Fazer download do arquivo

GET {endpoint}/openai/v1/files/{file_id}/content

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
file_id	caminho	Yes	cadeia	A ID do arquivo a ser usado nessa solicitação.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
application/octet-stream	cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Executar classificador

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run

Execute um avaliador.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Não
└─ graders	objeto		Não
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ sampling_params		Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não
item		O item de conjunto de dados fornecido ao avaliador. Isso será usado para preencher o `item` namespace. Consulte o guia para obter mais detalhes.	Não
model_sample	cadeia	O exemplo de modelo a ser avaliado. Esse valor será usado para preencher o `sample` namespace. Consulte o guia para obter mais detalhes. A `output_json` variável será preenchida se o exemplo de modelo for um cadeia de caracteres JSON válida.	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.RunGraderResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Validar o avaliador

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate

Valide um avaliador.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Não
└─ graders	objeto		Não
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ sampling_params		Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ValidateGraderResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar um trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs

Cria um trabalho de ajuste fino que inicia o processo de criação de um novo modelo a partir de um determinado conjunto de dados.

A resposta inclui detalhes do trabalho enfileirado, incluindo o status do trabalho e o nome dos modelos ajustados após a conclusão.

Saiba mais sobre ajuste fino

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Padrão
hiperparâmetros	objeto	Os hiperparâmetros usados no trabalho de ajuste fino. Agora, esse valor foi preterido em favor de `method`, e deve ser passado sob o parâmetro `method`.	Não
└─ tamanho_do_lote (batch_size)	enumeração	Valores possíveis: `auto`	Não
└─ multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
└─ n_epochs	enumeração	Valores possíveis: `auto`	Não
Integrações	matriz	Uma lista de integrações para habilitar seu trabalho de ajuste fino.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
método	OpenAI.FineTuneMethod	O método usado no ajuste fino.	Não
modelo	cadeia de caracteres (veja os modelos válidos abaixo)	O nome do modelo a ser refinado. Você pode selecionar um dos modelos com suporte.	Yes
semente	inteiro	A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros iniciais e de trabalho deve produzir os mesmos resultados, mas pode diferir em casos raros. Se uma semente não for especificada, uma será gerada para você.	Não
sufixo	cadeia	Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado. Por exemplo, um `suffix` "custom-model-name" produz um nome de modelo como `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	Não	Nenhum
arquivo_de_treinamento	cadeia	A ID de um arquivo carregado que contém os dados de treinamento. Consulte carregar arquivo para saber como carregar um arquivo. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade `fine-tune`. O conteúdo do arquivo deve ser diferente dependendo se o modelo usa o chat ou se o método de ajuste fino usa o formato de preferência. Consulte o guia de ajuste fino para obter mais detalhes.	Yes
arquivo_de_validação	cadeia	A ID de um arquivo carregado que contém os dados de validação. Se você fornecer esse arquivo, os dados serão usados para gerar validação métricas periódicas durante o ajuste fino. Essas métricas podem ser exibidas em o arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos arquivos de treinamento e validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade `fine-tune`. Consulte o guia de ajuste fino para obter mais detalhes.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar trabalhos de ajuste fino paginados

GET {endpoint}/openai/v1/fine_tuning/jobs

Liste os trabalhos de ajuste fino da sua organização

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
after	consulta	Não	cadeia	Identificador do último trabalho da solicitação de paginação anterior.
limite	consulta	Não	inteiro	Número de trabalhos de ajuste fino a serem recuperados.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListPaginatedFineTuningJobsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Recuperar o trabalho de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}

Obtenha informações sobre um trabalho de ajuste fino.

Saiba mais sobre ajuste fino

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Cancelar o trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel

Cancele imediatamente um trabalho de ajuste fino.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser cancelado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar pontos de verificação de trabalho de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

Liste os pontos de verificação para um trabalho de ajuste fino.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para o qual obter pontos de verificação.
after	consulta	Não	cadeia	Identificador da última ID do ponto de verificação da solicitação de paginação anterior.
limite	consulta	Não	inteiro	Número de pontos de verificação a serem recuperados.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListFineTuningJobCheckpointsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Ajuste fino – Copiar ponto de verificação

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_name}/copy

Cria uma cópia de um ponto de verificação de ajuste fino na conta de destino e região fornecidas.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-copy-ft-checkpoints	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso a operações de cópia de ponto de verificação para modelos, uma versão prévia do recurso do AOAI. Esse recurso requer que o cabeçalho 'aoai-copy-ft-checkpoints' seja definido como 'preview'.
accept	cabeçalho	Yes	cadeia Valores possíveis: `application/json`
fine_tuning_job_id	caminho	Yes	cadeia
fine_tuning_checkpoint_name	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Padrão
destinationResourceId	cadeia	A ID do recurso de destino a ser copiada.	Yes
região	cadeia	A região para a qual copiar o modelo.	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	CopyModelResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Ajuste fino – Obter ponto de verificação

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_name}/copy

Obtém o status de uma cópia de ponto de verificação de ajuste fino.

Observação

Esta operação do OpenAI do Azure está em versão prévia e está sujeita a alterações.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
aoai-copy-ft-checkpoints	cabeçalho	Yes	cadeia Valores possíveis: `preview`	Habilita o acesso a operações de cópia de ponto de verificação para modelos, uma versão prévia do recurso do AOAI. Esse recurso requer que o cabeçalho 'aoai-copy-ft-checkpoints' seja definido como 'preview'.
accept	cabeçalho	Yes	cadeia Valores possíveis: `application/json`
fine_tuning_job_id	caminho	Yes	cadeia
fine_tuning_checkpoint_name	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	CopyModelResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar eventos de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events

Obtenha atualizações de status para um trabalho de ajuste fino.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino para o qual obter eventos.
after	consulta	Não	cadeia	Identificador do último evento da solicitação de paginação anterior.
limite	consulta	Não	inteiro	Número de eventos a serem recuperados.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListFineTuningJobEventsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Pausar o trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause

Pausar um trabalho de ajuste fino.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser pausado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Retomar o trabalho de ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume

Retomar uma tarefa de ajuste fino pausada.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
fine_tuning_job_id	caminho	Yes	cadeia	A ID do trabalho de ajuste fino a ser retomado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar modelos

GET {endpoint}/openai/v1/models

Lista os modelos disponíveis no momento e fornece informações básicas sobre cada um deles, como o proprietário e a disponibilidade.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListModelsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Recuperar modelo

GET {endpoint}/openai/v1/models/{model}

Recupera uma instância de modelo, fornecendo informações básicas sobre o modelo, como o proprietário e permissões.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
modelo	caminho	Yes	cadeia	A ID do modelo a ser usado nssa solicitação.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.Model

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar resposta

POST {endpoint}/openai/v1/responses

Cria uma resposta de modelo.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Padrão
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
include	matriz	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. No momento, os valores com suporte são: - `code_interpreter_call.outputs`: inclui as saídas da execução de código python nos itens de chamada de ferramenta de interpretador de código. - `computer_call_output.output.image_url`: incluir urls de imagem da saída da chamada de computador. - `file_search_call.results`: incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de arquivos. - `message.input_image.image_url`: incluir urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: inclua os logprobs com mensagens de assistente. - `reasoning.encrypted_content`: inclui uma versão criptografada do raciocínio tokens em saídas de item de raciocínio. Isso permite que itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o parâmetro `store` é definido como `false`, ou quando uma organização é registrada no programa de retenção de dados zero).	Não
entrada	cadeia de caracteres ou matriz		Não
instructions	cadeia	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
max_output_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Yes
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
solicitação	objeto	Referência a um modelo de prompt e suas variáveis.	Não
└─ id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia	Versão opcional do modelo de prompt.	Não
reasoning	objeto	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
armazenar	boolean	Se deseja armazenar a resposta gerada do modelo para recuperação posterior via API.	Não	Verdade
fluxo	boolean	Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. Consulte a seção Streaming abaixo para obter mais informações.	Não	Falso
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não	1
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objeto	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.	Não
└─ tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa de arquivo. - Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código.	Não
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 de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não	1
truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Exemplos

Exemplo

Criar uma resposta de modelo

POST {endpoint}/openai/v1/responses

Resposta GET

GET {endpoint}/openai/v1/responses/{response_id}

Recupera uma resposta de modelo com a ID fornecida.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Yes	cadeia
include_obfuscation	consulta	Não	boolean	Quando verdadeiro, a ofuscação de fluxo será habilitada. A ofuscação de fluxo adiciona caracteres aleatórios a um campo `obfuscation` em eventos delta de streaming para normalizar 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 ao fluxo de dados. Você pode definir `include_obfuscation` como falso para otimizar a largura de banda se confiar nos links de rede entre seu aplicativo e a API do OpenAI.
include[]	consulta	Não	matriz

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Excluir resposta

DELETE {endpoint}/openai/v1/responses/{response_id}

Exclui uma resposta por ID.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar itens de entrada

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Retorna uma lista de itens de entrada para uma determinada resposta.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
response_id	caminho	Yes	cadeia
limite	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem ascendente e`desc` para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. `after` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada subsequente pode incluir after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. `before` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ResponseItemList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar os repositórios de vetores

GET {endpoint}/openai/v1/vector_stores

Retorna uma lista de repositórios de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
limite	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem ascendente e`desc` para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. `after` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada subsequente pode incluir after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. `before` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListVectorStoresResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Createvectorstore

POST {endpoint}/openai/v1/vector_stores

Cria um repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
chunking_strategy	objeto	A estratégia padrão. Atualmente, essa estratégia usa um `max_chunk_size_tokens` de `800` e `chunk_overlap_tokens` de `400`.	Não
└─ estático	OpenAI.StaticChunkingStrategy		Não
└─ tipo	enumeração	Sempre `static`. Valores possíveis: `static`	Não
expires_after	OpenAI.VectorStoreExpirationAfter	A política de expiração de um repositório de vetores.	Não
identificadores_de_arquivos	matriz	Uma lista de IDs de Arquivo que o repositório de vetores deve usar. Útil para ferramentas como `file_search`, que podem acessar arquivos.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome do repositório de vetores.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Exemplos

Arquivo de exemplo não encontrado: ./examples/vector_stores.json

Obter o repositório de vetores

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}

Recupera um repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores a ser recuperado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Modificar o repositório de vetores

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}

Modifica um repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores a ser modificado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
expires_after	objeto	A política de expiração de um repositório de vetores.	Não
└─ âncora	enumeração	Carimbo de data/hora da âncora após o qual a política de expiração se aplica. Âncoras com suporte: `last_active_at`. Valores possíveis: `last_active_at`	Não
└─ dias	inteiro	O número de dias após o tempo de ancoragem em que o repositório de vetores expirará.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome do repositório de vetores.	Não

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Excluir o repositório de vetores

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}

Exclui um repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores a ser excluído.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.DeleteVectorStoreResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar o lote de arquivos do repositório de vetores

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches

Crie um lote de arquivos de repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores para o qual criar um lote de arquivos.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Não
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	A estratégia de divisão em partes usada para dividir os arquivos. Se não estiver definida, usará a estratégia de `auto`.	Não
identificadores_de_arquivos	matriz	Uma lista de IDs de Arquivo que o repositório de vetores deve usar. Útil para ferramentas como `file_search`, que podem acessar arquivos.	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreFileBatchObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter o lote de arquivos do repositório de vetores

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}

Recupera um lote de arquivos de repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores à qual o lote de arquivos pertence.
batch_id	caminho	Yes	cadeia	A ID do lote de arquivos que está sendo recuperado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreFileBatchObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Cancelar o lote de arquivos do repositório de vetores

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

Cancele um lote de arquivos de repositório de vetores. Isso tenta cancelar o processamento de arquivos neste lote o mais rápido possível.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores à qual o lote de arquivos pertence.
batch_id	caminho	Yes	cadeia	A ID do lote de arquivos a ser cancelada.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreFileBatchObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar os arquivos no lote do repositório de vetores

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

Retorna uma lista de arquivos de repositório de vetores em um lote.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores à qual o lote de arquivos pertence.
batch_id	caminho	Yes	cadeia	A ID do lote de arquivos à qual os arquivos pertencem.
limite	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem ascendente e`desc` para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. `after` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada subsequente pode incluir after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. `before` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.
filtro	consulta	Não		Filtrar por status do arquivo. Uma opção entre `in_progress`, `completed`, `failed`, `cancelled`.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListVectorStoreFilesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Listar os arquivos do repositório de vetores

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

Retorna uma lista de arquivos de repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores ao qual os arquivos pertencem.
limite	consulta	Não	inteiro	Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o o padrão é 20.
ordem	consulta	Não	cadeia Valores possíveis: `asc`, `desc`	Classificar a ordem pelo carimbo de data/hora `created_at` dos objetos. `asc` para ordem ascendente e`desc` para ordem decrescente.
after	consulta	Não	cadeia	Um cursor para uso na paginação. `after` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada subsequente pode incluir after=obj_foo para buscar a próxima página da lista.
before	consulta	Não	cadeia	Um cursor para uso na paginação. `before` é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, seu A chamada seguinte pode incluir before=obj_foo para buscar a página anterior da lista.
filtro	consulta	Não		Filtrar por status do arquivo. Uma opção entre `in_progress`, `completed`, `failed`, `cancelled`.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.ListVectorStoreFilesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Criar o arquivo do repositório de vetores

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

Crie um arquivo de repositório de vetores anexando um Arquivo a um repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores para o qual criar um Arquivo.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Não
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	A estratégia de divisão em partes usada para dividir os arquivos. Se não estiver definida, usará a estratégia de `auto`.	Não
file_id	cadeia	Uma ID de arquivo que o repositório de vetores deve usar. Útil para ferramentas como `file_search`, que podem acessar arquivos.	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreFileObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Obter o arquivo do repositório de vetores

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Recupera um arquivo de repositório de vetores.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores ao qual o arquivo pertence.
file_id	caminho	Yes	cadeia	A ID do arquivo que está sendo recuperado.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreFileObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Atualizar os atributos de arquivo do repositório de vetores

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia
file_id	caminho	Yes	cadeia

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Corpo da solicitação

Tipo de conteúdo: application/json

Nome	Tipo	Descrição	Obrigatório	Padrão
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Yes

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.VectorStoreFileObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Excluir o arquivo do repositório de vetores

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

Exclui um arquivo de repositório de vetores. Isso removerá o arquivo do repositório de vetores, mas o próprio arquivo não será excluído. Para excluir o arquivo, use o ponto de extremidade de exclusão do arquivo.

Parâmetros

Nome	No	Obrigatório	Tipo	Descrição
ponto de extremidade	caminho	Yes	cadeia url	Pontos de extremidade do OpenAI do Azure com suporte (protocolo e nome do host, por exemplo: `https://aoairesource.openai.azure.com`. Substitua "aoairesource" pelo nome do recurso do OpenAI do Azure). https://{your-resource-name}.openai.azure.com
api-version	consulta	Não		A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação. `v1` se não for especificado de outra forma.
vector_store_id	caminho	Yes	cadeia	A ID do repositório de vetores ao qual o arquivo pertence.
file_id	caminho	Yes	cadeia	A ID do arquivo a ser excluído.

Cabeçalho da solicitação

Use a autenticação baseada em token ou a chave de API. A autenticação com autenticação baseada em token é recomendada e mais segura.

Nome	Obrigatório	Tipo	Descrição
Autorização	Verdade	cadeia	exemplo:`Authorization: Bearer {Azure_OpenAI_Auth_Token}` Para gerar um token de autenticação usando a CLI do Azure: `az account get-access-token --resource https://cognitiveservices.azure.com` Tipo: oauth2 URL de autorização: `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` escopo: `https://cognitiveservices.azure.com/.default`
chave da API	Verdade	cadeia	Forneça a chave da API do OpenAI do Azure aqui

Respostas

Código de Status: 200

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

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	OpenAI.DeleteVectorStoreFileResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Tipo de conteúdo	Tipo	Descrição
aplicativo/json	AzureErrorResponse

Componentes

AzureAIFoundryModelsApiVersion

Propriedade	Valor
Tipo	cadeia
Valores	`v1` `preview`

AzureChatCompletionResponseMessage

O componente do modelo de resposta estendida para mensagens de resposta de conclusão de chat no serviço OpenAI do Azure. Esse modelo adiciona suporte para o contexto de mensagem de chat, usado pelo recurso On Your Data para intenção, citações e outras informações relacionadas à geração aumentada de recuperação executada.

Nome	Tipo	Descrição	Obrigatório
Anotações	matriz	Anotações para a mensagem, quando aplicável, como ao usar a ferramenta de pesquisa da Web.	Não
audio	objeto	Se a modalidade de saída de áudio for solicitada, este objeto conterá dados sobre a resposta de áudio do modelo. .	Não
└─ dados	cadeia	Bytes de áudio codificados em Base64 gerados pelo modelo, no formato especificado na solicitação.	Não
└─ data_de_expiração	inteiro	O carimbo de data/hora UNIX (em segundos) indicando até quando essa resposta de áudio não estará mais acessível no servidor para uso em conversas em vários turnos.	Não
└─ id	cadeia	Identificador único para essa resposta de áudio.	Não
└─ transcrição	cadeia	Transcrição do áudio gerado pelo modelo.	Não
conteúdo	cadeia	O conteúdo da mensagem.	Yes
contexto	objeto	Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzidas pelo serviço OpenAI do Azure ao usar comportamento de extensão. Isso inclui informações de intenção e citação do recurso On Your Data.	Não
└─ todos_os_documentos_recuperados	objeto	Informações resumidas sobre documentos recuperados pela operação de recuperação de dados.	Não
└─ chunk_id	cadeia	A ID da parte da citação.	Não
└─ conteúdo	cadeia	O conteúdo da citação.	Não
└─ índice_fonte_de_dados	inteiro	O índice da fonte de dados usada para recuperação.	Não
└─ caminho do arquivo	cadeia	O caminho do arquivo para a citação.	Não
└─ motivo_do_filtro	enumeração	Se aplicável, uma indicação de por que o documento foi filtrado. Valores possíveis: `score`, `rerank`	Não
└─ pontuação_original_de_busca	número	A pontuação de pesquisa original para a recuperação.	Não
└─ pontuação_de_reclassificação	número	Pontuação de reclassificação para a recuperação.	Não
└─ consultas_de_busca	matriz	As consultas de pesquisa executadas para recuperar documentos.	Não
└─ título	cadeia	O título da citação.	Não
└─ URL	cadeia	A URL da citação.	Não
└─ citações	matriz	As citações produzidas pela recuperação de dados.	Não
└─ intent	cadeia	A intenção detectada do histórico de chat, que é usada para levar o contexto da conversa entre interações	Não
function_call	objeto	Preterido e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	Não
└─ Argumentos	cadeia		Não
└─ nome	cadeia		Não
reasoning_content	cadeia	Uma propriedade de extensão específica do Azure que contém o conteúdo de raciocínio gerado de modelos com suporte.	Não
recusa	cadeia	A mensagem de recusa gerada pelo modelo.	Yes
função	enumeração	A função do autor dessa mensagem. Valores possíveis: `assistant`	Yes
tool_calls	ChatCompletionMessageToolCallsItem	As chamadas de ferramenta geradas pelo modelo, como chamadas de função.	Não

AzureChatCompletionStreamResponseDelta

O modelo de resposta estendida para uma mensagem de resposta de chat de streaming no serviço OpenAI do Azure. Esse modelo adiciona suporte para o contexto de mensagem de chat, usado pelo recurso On Your Data para intenção, citações e outras informações relacionadas à geração aumentada de recuperação executada.

Nome	Tipo	Descrição	Obrigatório
audio	objeto		Não
└─ dados	cadeia		Não
└─ data_de_expiração	inteiro		Não
└─ id	cadeia		Não
└─ transcrição	cadeia		Não
conteúdo	cadeia	O conteúdo da mensagem de parte.	Não
contexto	objeto	Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzidas pelo serviço OpenAI do Azure ao usar comportamento de extensão. Isso inclui informações de intenção e citação do recurso On Your Data.	Não
└─ todos_os_documentos_recuperados	objeto	Informações resumidas sobre documentos recuperados pela operação de recuperação de dados.	Não
└─ chunk_id	cadeia	A ID da parte da citação.	Não
└─ conteúdo	cadeia	O conteúdo da citação.	Não
└─ índice_fonte_de_dados	inteiro	O índice da fonte de dados usada para recuperação.	Não
└─ caminho do arquivo	cadeia	O caminho do arquivo para a citação.	Não
└─ motivo_do_filtro	enumeração	Se aplicável, uma indicação de por que o documento foi filtrado. Valores possíveis: `score`, `rerank`	Não
└─ pontuação_original_de_busca	número	A pontuação de pesquisa original para a recuperação.	Não
└─ pontuação_de_reclassificação	número	Pontuação de reclassificação para a recuperação.	Não
└─ consultas_de_busca	matriz	As consultas de pesquisa executadas para recuperar documentos.	Não
└─ título	cadeia	O título da citação.	Não
└─ URL	cadeia	A URL da citação.	Não
└─ citações	matriz	As citações produzidas pela recuperação de dados.	Não
└─ intent	cadeia	A intenção detectada do histórico de chat, que é usada para levar o contexto da conversa entre interações	Não
function_call	objeto	Preterido e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	Não
└─ Argumentos	cadeia		Não
└─ nome	cadeia		Não
reasoning_content	cadeia	Uma propriedade de extensão específica do Azure que contém o conteúdo de raciocínio gerado de modelos com suporte.	Não
recusa	cadeia	A mensagem de recusa gerada pelo modelo.	Não
função	objeto	A função do autor de uma mensagem	Não
tool_calls	matriz		Não

AzureChatDataSource

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

Discriminador para AzureChatDataSource

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

Valor do tipo	Esquema
`azure_search`	AzureSearchChatDataSource
`azure_cosmos_db`	AzureCosmosDBChatDataSource
`elasticsearch`	ElasticsearchChatDataSource
`pinecone`	PineconeChatDataSource
`mongo_db`	MongoDBChatDataSource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	objeto		Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
access_token	cadeia		Yes
tipo	enumeração	Valores possíveis: `access_token`	Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
chave	cadeia		Yes
tipo	enumeração	Valores possíveis: `api_key`	Yes

AzureChatDataSourceAuthenticationOptions

Discriminador para AzureChatDataSourceAuthenticationOptions

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

Valor do tipo	Esquema
`system_assigned_managed_identity`	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
`access_token`	AzureChatDataSourceAccessTokenAuthenticationOptions
`connection_string`	AzureChatDataSourceConnectionStringAuthenticationOptions
`key_and_key_id`	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
`username_and_password`	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	AzureChatDataSourceAuthenticationOptionsType		Yes

AzureChatDataSourceAuthenticationOptionsType

Propriedade	Valor
Tipo	cadeia
Valores	`api_key` `username_and_password` `connection_string` `key_and_key_id` `encoded_api_key` `access_token` `system_assigned_managed_identity` `user_assigned_managed_identity`

AzureChatDataSourceConnectionStringAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
connection_string	cadeia		Yes
tipo	enumeração	Valores possíveis: `connection_string`	Yes

AzureChatDataSourceDeploymentNameVectorizationSource

Representa uma fonte de vetorização que faz chamadas de serviço internas em uma implantação de modelo de inserção do OpenAI do Azure. Em contraste com a fonte de vetorização baseada em ponto de extremidade, uma fonte de vetorização baseada em nome de implantação deve fazer parte do mesmo recurso do OpenAI do Azure, mas pode ser usada até mesmo em redes privadas.

Nome	Tipo	Descrição	Obrigatório
nome_do_desdobramento	cadeia	A implantação do modelo de inserção a ser usada para vetorização. Essa implantação deve existir no mesmo OpenAI do Azure recurso como a implantação de modelo que está sendo usada para conclusões de chat.	Yes
dimensions	inteiro	O número de dimensões a serem solicitadas em inserções. Só há suporte em modelos 'text-embedding-3' e posteriores.	Não
tipo	enumeração	O identificador de tipo, sempre 'deployment_name' para esse tipo de origem de vetorização. Valores possíveis: `deployment_name`	Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
encoded_api_key	cadeia		Yes
tipo	enumeração	Valores possíveis: `encoded_api_key`	Yes

AzureChatDataSourceEndpointVectorizationSource

Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de inserção do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
autenticação	objeto		Yes
└─ token_de_acesso	cadeia		Não
└─ chave	cadeia		Não
└─ tipo	enumeração	Valores possíveis: `access_token`	Não
dimensions	inteiro	O número de dimensões a serem solicitadas em inserções. Só há suporte em modelos 'text-embedding-3' e posteriores.	Não
ponto de extremidade	cadeia	Especifica a URL do ponto de extremidade do recurso da qual as incorporações devem ser recuperadas. Deve estar no formato de: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. O parâmetro de consulta api-version não é permitido.	Yes
tipo	enumeração	O identificador de tipo, sempre 'endpoint' para esse tipo de origem de vetorização. Valores possíveis: `endpoint`	Yes

AzureChatDataSourceIntegratedVectorizationSource

Representa uma fonte de vetorização integrada, conforme definido no recurso de pesquisa de suporte.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O identificador de tipo, sempre 'integrated' para esse tipo de origem de vetorização. Valores possíveis: `integrated`	Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório
chave	cadeia		Yes
key_id	cadeia		Yes
tipo	enumeração	Valores possíveis: `key_and_key_id`	Yes

AzureChatDataSourceModelIdVectorizationSource

Representa uma fonte de vetorização que faz chamadas de serviço com base em uma ID do modelo de serviço de pesquisa. Atualmente, esse tipo de fonte só tem suporte do Elasticsearch.

Nome	Tipo	Descrição	Obrigatório	Padrão
model_id	cadeia	A ID de build do modelo de inserção a ser usada para vetorização.	Yes
tipo	enumeração	O identificador de tipo, sempre 'model_id' para esse tipo de fonte de vetorização. Valores possíveis: `model_id`	Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `system_assigned_managed_identity`	Yes

AzureChatDataSourceType

Propriedade	Valor
Tipo	cadeia
Valores	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
managed_identity_resource_id	cadeia		Yes
tipo	enumeração	Valores possíveis: `user_assigned_managed_identity`	Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Nome	Tipo	Descrição	Obrigatório
senha	cadeia		Yes
tipo	enumeração	Valores possíveis: `username_and_password`	Yes
nome de usuário	cadeia		Yes

AzureChatDataSourceVectorizationSource

Uma representação de uma fonte de vetorização de dados utilizável como um recurso de inserção com uma fonte de dados.

Discriminador para AzureChatDataSourceVectorizationSource

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

Valor do tipo	Esquema
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChatDataSourceModelIdVectorizationSource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	objeto		Yes

AzureChatDataSourceVectorizationSourceType

Propriedade	Valor
Tipo	cadeia
Valores	`endpoint` `deployment_name` `model_id` `integrated`

AzureChatMessageContext

Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzidas pelo serviço OpenAI do Azure ao usar o comportamento da extensão. Isso inclui informações de intenção e citação do recurso On Your Data.

Nome	Tipo	Descrição	Obrigatório
all_retrieved_documents	objeto	Informações resumidas sobre documentos recuperados pela operação de recuperação de dados.	Não
└─ chunk_id	cadeia	A ID da parte da citação.	Não
└─ conteúdo	cadeia	O conteúdo da citação.	Não
└─ índice_fonte_de_dados	inteiro	O índice da fonte de dados usada para recuperação.	Não
└─ caminho do arquivo	cadeia	O caminho do arquivo para a citação.	Não
└─ motivo_do_filtro	enumeração	Se aplicável, uma indicação de por que o documento foi filtrado. Valores possíveis: `score`, `rerank`	Não
└─ pontuação_original_de_busca	número	A pontuação de pesquisa original para a recuperação.	Não
└─ pontuação_de_reclassificação	número	Pontuação de reclassificação para a recuperação.	Não
└─ consultas_de_busca	matriz	As consultas de pesquisa executadas para recuperar documentos.	Não
└─ título	cadeia	O título da citação.	Não
└─ URL	cadeia	A URL da citação.	Não
citações	matriz	As citações produzidas pela recuperação de dados.	Não
intenção	cadeia	A intenção detectada do histórico de chat, que é usada para levar o contexto da conversa entre interações	Não

AzureContentFilterBlocklistResult

Uma coleção de resultados de filtragem verdadeiro/falso para listas de bloqueio personalizadas configuradas.

Nome	Tipo	Descrição	Obrigatório	Padrão
details	matriz	Os pares de IDs individuais da lista de bloqueios e se resultaram em uma ação de filtragem.	Não
filtrado	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 intervalo de texto de conclusão, conforme usado pelos resultados do filtro de conteúdo do OpenAI do Azure.

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

AzureContentFilterCompletionTextSpanDetectionResult

Nome	Tipo	Descrição	Obrigatório
details	matriz	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
filtrado	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 verdadeiro/falso dos tópicos personalizados configurados.

Nome	Tipo	Descrição	Obrigatório	Padrão
details	matriz	Os pares de IDs de tópicos individuais e se eles foram detectados.	Não
filtrado	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	Descrição	Obrigatório	Padrão
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

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	Descrição	Obrigatório	Padrão
redacted_text	cadeia	O texto editado com informações de PII removidas ou mascaradas.	Não
sub_categories	matriz	Resultados detalhados para PIIHarmSubCategory(s) individuais.	Não

AzureContentFilterResultForChoice

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

Nome	Tipo	Descrição	Obrigatório
custom_blocklists	objeto	Uma coleção de resultados de filtragem verdadeiro/falso para listas de bloqueio personalizadas configuradas.	Não
└─ detalhes	matriz	Os pares de IDs individuais da lista de bloqueios e se resultaram em uma ação de filtragem.	Não
└─ filtrado	boolean	Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem.	Não
custom_topics	objeto	Uma coleção de resultados de filtragem verdadeiro/falso dos tópicos personalizados configurados.	Não
└─ detalhes	matriz	Os pares de IDs de tópicos individuais e se eles foram detectados.	Não
└─ filtrado	boolean	Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem.	Não
erro	objeto	Se estiver presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação.	Não
└─ código	inteiro	Um código distinto e legível pelo computador associado ao erro.	Não
Mensagem └─	cadeia	Uma mensagem legível por humanos associada ao erro.	Não
ódio	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
personally_identifiable_information	objeto	Um resultado de detecção de filtro de conteúdo para informações de identificação pessoal que inclui extensões de danos.	Não
└─ redacted_text	cadeia	O texto editado com informações de PII removidas ou mascaradas.	Não
└─ sub_categories	matriz	Resultados detalhados para PIIHarmSubCategory(s) individuais.	Não
conteúdo ofensivo	objeto	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.	Não
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Não
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Não
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.	Não
└─ citação	objeto	Se disponível, os detalhes da citação que descrevem a licença associada e sua localização.	Não
└─ URL	cadeia	A URL associada à licença.	Não
└─ licença	cadeia	O nome ou identificador da licença associada à detecção.	Não
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Não
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Não
protected_material_text	objeto	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.	Não
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Não
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Não
self_harm	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
sexual	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		Não
violência	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não

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	Descrição	Obrigatório
content_filter_results	objeto	Os detalhes da categoria de filtro de conteúdo para o resultado.	Não
└─ listas_personalizadas_de_bloqueio	objeto	Uma coleção de resultados de filtragem verdadeiro/falso para listas de bloqueio personalizadas configuradas.	Não
└─ detalhes	matriz	Os pares de IDs individuais da lista de bloqueios e se resultaram em uma ação de filtragem.	Não
└─ filtrado	boolean	Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem.	Não
└─ tópicos_personalizados	objeto	Uma coleção de resultados de filtragem verdadeiro/falso dos tópicos personalizados configurados.	Não
└─ detalhes	matriz	Os pares de IDs de tópicos individuais e se eles foram detectados.	Não
└─ filtrado	boolean	Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem.	Não
└─ erro	objeto	Se estiver presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação.	Não
└─ código	inteiro	Um código distinto e legível pelo computador associado ao erro.	Não
Mensagem └─	cadeia	Uma mensagem legível por humanos associada ao erro.	Não
└─ ódio	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
└─ ataque_indireto	objeto	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.	Não
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Não
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ desbloqueio	objeto	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.	Não
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Não
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ palavrões	objeto	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.	Não
└─ detectado	boolean	Se a categoria de conteúdo rotulado foi detectada no conteúdo.	Não
└─ filtrado	boolean	Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ automutilação	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
└─ sexual	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
└─ violência	objeto	Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.	Não
└─ filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Não
└─ severidade	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Não
prompt_index	inteiro	O índice da solicitação de entrada associado às categorias de resultado do filtro de conteúdo que acompanham.	Não

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	Descrição	Obrigatório	Padrão
filtrado	boolean	Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo.	Yes
severity	enumeração	A severidade rotulada do conteúdo. Valores possíveis: `safe`, , `low`, `mediumhigh`	Yes

AzureCosmosDBChatDataSource

Representa uma configuração de fonte de dados que usará um recurso do Azure CosmosDB.

Nome	Tipo	Descrição	Obrigatório	Padrão
parâmetros	objeto	As informações de parâmetro para controlar o uso da fonte de dados do Azure CosmosDB.	Yes
└─ permitir_resultado_parcial	boolean	Se definido como verdadeiro, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falham. Se isso não for especificado ou especificado como falso, a solicitação falhará caso uma consulta de pesquisa falhe.	Não	Falso
└─ autenticação	AzureChatDataSourceConnectionStringAuthenticationOptions		Não
└─ container_name	cadeia		Não
└─ nome_do_banco_de_dados	cadeia		Não
└─ embedding_dependency	AzureChatDataSourceVectorizationSource	Uma representação de uma fonte de vetorização de dados utilizável como um recurso de inserção com uma fonte de dados.	Não
└─ mapeamento_de_campos	objeto		Não
└─ campos_de_conteúdo	matriz		Não
└─ separador_dos_campos_de_conteúdo	cadeia		Não
└─ campo_caminho_do_arquivo	cadeia		Não
└─ campo_do_título	cadeia		Não
└─ campo_de_url	cadeia		Não
└─ campos_de_vetores	matriz		Não
└─ in_scope	boolean	Se as consultas devem ser restritas ao uso dos dados indexados.	Não
└─ incluir_contextos	matriz	As propriedades de contexto de saída a serem incluídas na resposta. Por padrão, as citações e a intenção serão solicitadas.	Não	['citações', 'intenções']
└─ nome_do_índice	cadeia		Não
└─ consultas_de_busca_máximas	inteiro	O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário. Por padrão, o sistema fará uma determinação automática.	Não
└─ rigidez	inteiro	A rigorosidade configurada da filtragem de relevância da pesquisa. A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.	Não
└─ top_n_documents	inteiro	O número configurado de documentos a serem apresentados na consulta.	Não
tipo	enumeração	O identificador de tipo discriminado, que é sempre 'azure_cosmos_db'. Valores possíveis: `azure_cosmos_db`	Yes

AzureCreateChatCompletionRequest

O modelo de solicitação estendida para conclusões de chat no serviço OpenAI do Azure. Isso adiciona a capacidade de fornecer fontes de dados para o recurso On Your Data.

Nome	Tipo	Descrição	Obrigatório	Padrão
audio	objeto	Parâmetros para saída de áudio. Necessário quando a saída de áudio é solicitada com `modalities: ["audio"]`.	Não
└─ formato	enumeração	Especifica o formato do áudio de saída. Deve ser um dos seguintes: `wav`, `mp3`, `flac` `opus` ou `pcm16`. Valores possíveis: `wav`, , `aac`, `mp3`, `flac`, , `opuspcm16`	Não
└─ voz	objeto		Não
data_sources	matriz	As fontes de dados a serem usadas para o recurso On Your Data, exclusivo do OpenAI do Azure.	Não
frequency_penalty	número	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.	Não	0
function_call	enumeração	Especificar uma determinada função por meio de `{"name": "my_function"}` força o modelo a chamar essa função. Valores possíveis: `none`, `auto`	Não
functions	matriz	Preterido em favor de `tools`. Uma lista de funções para as quais o modelo pode gerar entradas JSON.	Não
logit_bias	objeto	Modifica a probabilidade de tokens especificados que 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.	Não	Nenhum
logprobs	boolean	Se você quer retornar as probabilidades de log dos tokens de saída ou não. Se verdadeiro, retorna as probabilidades de log de cada token de saída retornado no `content` de `message`.	Não	Falso
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.	Não
número máximo de tokens	inteiro	O número máximo de tokens que podem ser gerados na conclusão. 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.	Não
messages	matriz	Uma lista de mensagens que resumem a conversa até agora. Dependendo do modelo usado, diferentes tipos de mensagem (modalidades) têm suporte, como texto, imagens e áudio.	Yes
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modalidades	objeto	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 modelo `gpt-4o-audio-preview` 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"]`	Não
modelo	cadeia	O identificador de implantação de modelo a ser usado para a solicitação de conclusão do chat.	Yes
n	inteiro	Quantas opções de preenchimento 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` para minimizar os custos.	Não	1
parallel_tool_calls	objeto	Se deseja habilitar a chamada de função paralela durante o uso da ferramenta.	Não
previsão	objeto	Representação base da saída prevista de um modelo.	Não
└─ tipo	OpenAI.ChatOutputPredictionType		Não
penalidade_de_presença	número	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.	Não	0
esforço de raciocínio	objeto	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
formato_de_resposta	objeto		Não
└─ tipo	enumeração	Valores possíveis: `text`, , `json_objectjson_schema`	Não
semente	inteiro	Esse recurso está em Versão Beta. Se especificado, nosso sistema fará o melhor esforço para amostrar de forma determinística, de modo que solicitações repetidas com os mesmos `seed` e os parâmetros retornem o mesmo resultado. O determinismo não é garantido e você deve consultar o parâmetro de resposta `system_fingerprint` para monitorar alterações no backend.	Não
parar	objeto	Não há suporte para modelos de raciocínio `o3` e `o4-mini`mais recentes. Até quatro sequências nas quais a API irá parar de gerar tokens. O O texto retornado não conterá a sequência de interrupção.	Não
armazenar	boolean	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.	Não	Falso
fluxo	boolean	Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor.	Não	Falso
stream_options	objeto	Opções para resposta de streaming. Defina isso somente quando você definir `stream: true`.	Não
└─ include_usage	boolean	Se definido, uma parte adicional será transmitida antes da `data: [DONE]` mensagem. O campo `usage` nesta parte mostra as estatísticas de uso do token para toda a solicitação, e o campo `choices` sempre será uma vazia matriz. Todas as outras partes também incluirão um campo `usage`, mas com um nulo valor. OBSERVAÇÃO: Se o fluxo for interrompido, você poderá não receber a parte de uso final que contém o uso total do token para a solicitação.	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não	1
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 determinada ferramenta por meio de `{"type": "function", "function": {"name": "my_function"}}` força o modelo a chamar essa ferramenta. `none` é o padrão quando não há nenhuma ferramenta presente. `auto` é o padrão se ferramentas estiverem presente.	Não
Ferramentas	matriz	Uma lista de ferramentas que o modelo pode chamar. No momento, há suporte apenas para funções como uma ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. Há suporte para um máximo de 128 funções.	Não
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 de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não	1
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar a monitorar e detectar abusos.	Não
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 os incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Saiba mais sobre como proteger aplicativos de IA usando o Microsoft Defender para Nuvem.	Não

AzureCreateChatCompletionResponse

O modelo de resposta de conclusão de chat de nível superior estendido para o serviço OpenAI do Azure. Esse modelo adiciona anotações de filtro de conteúdo de IA responsável para entrada de solicitação.

Nome	Tipo	Descrição	Obrigatório
opções	matriz		Yes
criado	inteiro	O carimbo de data/hora do UNIX (em segundos) de quando o preenchimento foi criado.	Yes
id	cadeia	Identificador exclusivo para conclusão de chat.	Yes
modelo	cadeia	O modelo usado para a conclusão do chat.	Yes
objeto	enumeração	O tipo de objeto, que é sempre `chat.completion`. Valores possíveis: `chat.completion`	Yes
prompt_filter_results	matriz	As anotações de filtro de conteúdo de IA responsável associadas a entradas de solicitação em conclusões de chat.	Não
system_fingerprint	cadeia	Essa impressão digital representa a configuração de back-end com a qual o modelo é executado. Pode ser usado com o parâmetro `seed` solicitação para entender quando foram feitas alterações de backend que podem impactar o determinismo.	Não
uso	OpenAI.CompletionUsage	Estatísticas de uso para a solicitação de preenchimento.	Não

AzureCreateChatCompletionStreamResponse

Nome	Tipo	Descrição	Obrigatório	Padrão
opções	matriz	Uma lista de opções de conclusão de chat. Pode conter mais de um elemento se `n` for maior que 1. Também pode estar vazio para a última parte se você definir `stream_options: {"include_usage": true}`.	Yes
content_filter_results	AzureContentFilterResultForChoice	Um resultado de filtro de conteúdo para um único item de resposta produzido por um sistema de IA generativa.	Não
criado	inteiro	O carimbo de data/hora do UNIX (em segundos) de quando o preenchimento foi criado. Cada parte tem o mesmo carimbo de data/hora.	Yes
delta	AzureChatCompletionStreamResponseDelta	O modelo de resposta estendida para uma mensagem de resposta de chat de streaming no serviço OpenAI do Azure. Esse modelo adiciona suporte para o contexto de mensagem de chat, usado pelo recurso On Your Data para intenção, citações e outras informações relacionadas à geração aumentada de recuperação executadas.	Não
id	cadeia	Identificador exclusivo para conclusão de chat. Cada parte tem a mesma ID.	Yes
modelo	cadeia	O modelo para gerar a conclusão.	Yes
objeto	enumeração	O tipo de objeto, que é sempre `chat.completion.chunk`. Valores possíveis: `chat.completion.chunk`	Yes
system_fingerprint	cadeia	Essa impressão digital representa a configuração de back-end com a qual o modelo é executado. Pode ser usado com o parâmetro `seed` solicitação para entender quando foram feitas alterações de backend que podem impactar o determinismo.	Não
uso	objeto	Estatísticas de uso para a solicitação de preenchimento.	Não
└─ completion_tokens	inteiro	Número de tokens na conclusão gerada.	Não	0
└─ completion_tokens_details	objeto	Divisão de tokens usados em uma conclusão.	Não
└─ tokens_de_predição_aceitos	inteiro	Ao usar saídas previstas, o número de tokens na previsão que apareceu na conclusão.	Não	0
└─ audio_tokens	inteiro	Tokens de entrada de áudio gerados pelo modelo.	Não	0
└─ tokens_de_raciocínio	inteiro	Tokens gerados pelo modelo para raciocínio.	Não	0
└─ rejected_prediction_tokens	inteiro	Ao usar saídas previstas, o número de tokens na previsão que não apareceu na conclusão. No entanto, assim como os tokens de raciocínio, esses tokens ainda são contabilizados no total de tokens de conclusão para fins de cobrança, saída e limites da janela de contexto.	Não	0
└─ prompt_tokens	inteiro	Número de tokens no prompt.	Não	0
└─ prompt_tokens_details	objeto	Divisão de tokens usados na solicitação.	Não
└─ audio_tokens	inteiro	Tokens de entrada de áudio presentes na solicitação.	Não	0
└─ tokens em cache	inteiro	Tokens armazenados em cache presentes no prompt.	Não	0
└─ total_tokens	inteiro	Número total de tokens utilizados na solicitação (prompt + conclusão).	Não	0

AzureCreateEmbeddingRequest

Nome	Tipo	Descrição	Obrigatório
dimensions	inteiro	O número de dimensões que as inserções de saída resultantes devem ter. Só há suporte em modelos `text-embedding-3` e posteriores.	Não
encoding_format	enumeração	O formato no qual as inserções devem ser retornadas. Pode ser um `float` ou `base64`. Valores possíveis: `float`, `base64`	Não
entrada	cadeia de caracteres ou matriz		Yes
modelo	cadeia	O modelo a ser usado para a solicitação de inserção.	Yes
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não

AzureCreateFileRequestMultiPart

Nome	Tipo	Descrição	Obrigatório
expires_after	objeto		Yes
└─ âncora	AzureFileExpiryAnchor		Não
└─ segundos	inteiro		Não
arquivo	cadeia		Yes
purpose	enumeração	A finalidade pretendida do arquivo carregado. Um de: - `assistants`: usado na API de Assistentes - `batch`: usado na API do Lote - `fine-tune`: usado para ajuste fino - `evals`: usado nos conjuntos de dados de avaliação Valores possíveis: `assistants`, , `batch`, `fine-tuneevals`	Yes

AzureCreateResponse

Nome	Tipo	Descrição	Obrigatório	Padrão
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
include	matriz	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. No momento, os valores com suporte são: - `code_interpreter_call.outputs`: inclui as saídas da execução de código python nos itens de chamada de ferramenta de interpretador de código. - `computer_call_output.output.image_url`: incluir urls de imagem da saída da chamada de computador. - `file_search_call.results`: incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de arquivos. - `message.input_image.image_url`: incluir urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: inclua os logprobs com mensagens de assistente. - `reasoning.encrypted_content`: inclui uma versão criptografada do raciocínio tokens em saídas de item de raciocínio. Isso permite que itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o parâmetro `store` é definido como `false`, ou quando uma organização é registrada no programa de retenção de dados zero).	Não
entrada	cadeia de caracteres ou matriz		Não
instructions	cadeia	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
max_output_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia	A implantação do modelo a ser usada para a criação dessa resposta.	Yes
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
solicitação	objeto	Referência a um modelo de prompt e suas variáveis.	Não
└─ id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia	Versão opcional do modelo de prompt.	Não
reasoning	objeto	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
armazenar	boolean	Se deseja armazenar a resposta gerada do modelo para recuperação posterior via API.	Não	Verdade
fluxo	boolean	Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. Consulte a seção Streaming abaixo para obter mais informações.	Não	Falso
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não	1
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objeto	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.	Não
└─ tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa de arquivo. - Chamadas de função (ferramentas personalizadas): funções definidas por você, permitindo que o modelo chame seu próprio código.	Não
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 de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não	1
truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não

AzureErrorResponse

Nome	Tipo	Descrição	Obrigatório
erro	objeto	Os detalhes do erro.	Não
└─ código	cadeia	O identificador distinto gerado pelo computador para o erro.	Não
└─ erro_interno			Não
Mensagem └─	cadeia	Uma mensagem legível por humanos associada ao erro.	Não
└─ param	cadeia	Se aplicável, o parâmetro de entrada de solicitação associado ao erro	Não
└─ tipo	enumeração	O tipo de objeto, sempre 'error.' Valores possíveis: `error`	Não

AzureEvalAPICompletionsSamplingParams

Nome	Tipo	Obrigatório
parallel_tool_calls	boolean	Não
formato_de_resposta	OpenAI.ResponseTextFormatConfiguration	Não
Ferramentas	matriz	Não

AzureEvalAPIModelSamplingParams

Nome	Tipo	Descrição	Obrigatório
número máximo de tokens	inteiro	O número máximo de tokens na saída gerada.	Não
esforço de raciocínio	enumeração	Controla o nível de esforço de raciocínio aplicado durante a geração. Valores possíveis: `low`, , `mediumhigh`	Não
semente	inteiro	Um valor inicial para inicializar a aleatoriedade durante a amostragem.	Não
temperatura	número	Uma temperatura mais alta aumenta a aleatoriedade nas saídas.	Não
top_p	número	Uma alternativa à temperatura para amostragem de núcleo; 1.0 inclui todos os tokens.	Não

AzureEvalAPIResponseSamplingParams

Nome	Tipo	Obrigatório
parallel_tool_calls	boolean	Não
formato_de_resposta	OpenAI.ResponseTextFormatConfiguration	Não
Ferramentas	matriz	Não

AzureFileExpiryAnchor

Propriedade	Valor
Tipo	cadeia
Valores	`created_at`

AzureFineTuneReinforcementMethod

Nome	Tipo	Descrição	Obrigatório
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Não
└─ graders	objeto		Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ sampling_params		Os parâmetros de amostragem do modelo.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não
hiperparâmetros	OpenAI.FineTuneReinforcementHyperparameters	Os hiperparâmetros usados no trabalho de ajuste fino de reforço.	Não
formato_de_resposta	objeto		Não
└─ esquema_json	objeto	Esquema JSON para o formato de resposta	Não
└─ tipo	enumeração	Tipo de formato de resposta Valores possíveis: `json_schema`	Não

AzureListFilesResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz		Yes
first_id	cadeia		Yes
has_more	boolean		Yes
last_id	cadeia		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

AzureOpenAIFile

Nome	Tipo	Descrição	Obrigatório
bytes	inteiro	O tamanho do arquivo, em bytes.	Yes
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da data em que o arquivo foi criado.	Yes
expira_em	inteiro	O carimbo de data/hora Unix (em segundos) de quando o arquivo expirará.	Não
nome do arquivo	cadeia	O nome do arquivo.	Yes
id	cadeia	O identificador do arquivo, que pode ser referenciado nos pontos finais da API.	Yes
objeto	enumeração	O tipo de objeto, que é sempre `file`. Valores possíveis: `file`	Yes
purpose	enumeração	A finalidade pretendida do arquivo. Os valores com suporte são `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune` e `fine-tune-results`. Valores possíveis: `assistants`, `assistants_output`, `batch`, `batch_output`, `fine-tune`, `fine-tune-results`, `evals`	Yes
status	enumeração	Valores possíveis: `uploaded`, `pending`, `running`, `processed`, `error`, `deleting`, `deleted`	Yes
detalhes_do_status	cadeia	Preterido. Para obter detalhes sobre por que um arquivo de treinamento de ajuste fino falhou na validação, consulte o `error` campo em `fine_tuning.job`.	Não

AzurePiiSubCategoryResult

Detalhes do resultado para PIIHarmSubCategory(s) individuais.

Nome	Tipo	Descrição	Obrigatório
detectado	boolean	Se a subcategoria de conteúdo rotulada 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 para essa subcategoria.	Yes
editado	boolean	Se o conteúdo foi editado para essa subcategoria.	Yes
sub_category	cadeia	O PIIHarmSubCategory que foi avaliado.	Yes

AzureResponse

Nome	Tipo	Descrição	Obrigatório	Padrão
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
criado_em	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Yes
erro	objeto	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ código	OpenAI.ResponseErrorCode	O código de erro da resposta.	Não
Mensagem └─	cadeia	Uma descrição do erro legível para humanos.	Não
id	cadeia	Identificador exclusivo para esta Resposta.	Yes
incomplete_details	objeto	Detalhes sobre por que a resposta está incompleta.	Yes
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
instructions	cadeia de caracteres ou matriz		Yes
max_output_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia	O modelo usado para gerar essa resposta.	Yes
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Yes
output_text	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
solicitação	objeto	Referência a um modelo de prompt e suas variáveis.	Não
└─ id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia	Versão opcional do modelo de prompt.	Não
reasoning	objeto	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
status	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Yes
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objeto	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.	Não
└─ tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
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 de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Yes
truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Yes

AzureSearchChatDataSource

Representa uma configuração de fonte de dados que usará um recurso do Azure Search.

Nome	Tipo	Descrição	Obrigatório	Padrão
parâmetros	objeto	As informações de parâmetro para controlar o uso da fonte de dados do Azure Search.	Yes
└─ permitir_resultado_parcial	boolean	Se definido como verdadeiro, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falham. Se isso não for especificado ou especificado como falso, a solicitação falhará caso uma consulta de pesquisa falhe.	Não	Falso
└─ autenticação	objeto		Não
└─ token_de_acesso	cadeia		Não
└─ chave	cadeia		Não
└─ managed_identity_resource_id	cadeia		Não
└─ tipo	enumeração	Valores possíveis: `access_token`	Não
└─ embedding_dependency	objeto	Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de inserção do OpenAI do Azure.	Não
└─ autenticação	AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions	O mecanismo de autenticação a ser usado com a origem de vetorização baseada em ponto de extremidade. A autenticação de ponto de extremidade dá suporte a mecanismos de token de acesso e chave de API.	Não
└─ deployment_name	cadeia	A implantação do modelo de inserção a ser usada para vetorização. Essa implantação deve existir no mesmo OpenAI do Azure recurso como a implantação de modelo que está sendo usada para conclusões de chat.	Não
└─ dimensões	inteiro	O número de dimensões a serem solicitadas em inserções. Só há suporte em modelos 'text-embedding-3' e posteriores.	Não
└─ endpoint	cadeia	Especifica a URL do ponto de extremidade do recurso da qual as incorporações devem ser recuperadas. Deve estar no formato de: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. O parâmetro de consulta api-version não é permitido.	Não
└─ tipo	enumeração	O identificador de tipo, sempre 'integrated' para esse tipo de origem de vetorização. Valores possíveis: `integrated`	Não
└─ endpoint	cadeia	O caminho de ponto de extremidade absoluto para o recurso do Azure Search a ser usado.	Não
└─ mapeamento_de_campos	objeto	Os mapeamentos de campo a serem usados com o recurso do Azure Search.	Não
└─ campos_de_conteúdo	matriz	Os nomes dos campos de índice que devem ser tratados como conteúdo.	Não
└─ separador_dos_campos_de_conteúdo	cadeia	O padrão separador que os campos de conteúdo devem usar.	Não
└─ campo_caminho_do_arquivo	cadeia	O nome do campo de índice a ser utilizado como um caminho de arquivo.	Não
└─ Campos de Vetores de Imagem	matriz	Os nomes dos campos que representam dados vetoriais de imagens.	Não
└─ campo_do_título	cadeia	O nome do campo de índice a ser utilizado como título.	Não
└─ campo_de_url	cadeia	O nome do campo de índice a ser utilizado como URL.	Não
└─ campos_de_vetores	matriz	Os nomes dos campos que representam dados vetoriais.	Não
└─ filtro	cadeia	Um filtro a ser aplicado à pesquisa.	Não
└─ in_scope	boolean	Se as consultas devem ser restritas ao uso dos dados indexados.	Não
└─ incluir_contextos	matriz	As propriedades de contexto de saída a serem incluídas na resposta. Por padrão, as citações e a intenção serão solicitadas.	Não	['citações', 'intenções']
└─ nome_do_índice	cadeia	O nome do índice a ser usado, conforme especificado no recurso do Azure Search.	Não
└─ consultas_de_busca_máximas	inteiro	O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário. Por padrão, o sistema fará uma determinação automática.	Não
└─ tipo_de_consulta	enumeração	O tipo de consulta para o recurso do Azure Search a ser usado. Valores possíveis: `simple`, , `semantic`, `vector`, `vector_simple_hybrid`, `vector_semantic_hybrid`	Não
└─ configuração_semântica	cadeia	Configuração semântica adicional para a consulta.	Não
└─ rigidez	inteiro	A rigorosidade configurada da filtragem de relevância da pesquisa. A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.	Não
└─ top_n_documents	inteiro	O número configurado de documentos a serem apresentados na consulta.	Não
tipo	enumeração	O identificador de tipo discriminado, que é sempre 'azure_search'. Valores possíveis: `azure_search`	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 os incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Saiba mais sobre como proteger aplicativos de IA usando o Microsoft Defender para Nuvem.

Nome	Tipo	Descrição	Obrigatório
application_name	cadeia	O nome do aplicativo. Informações pessoais confidenciais não devem ser incluídas nesse campo.	Não
end_user_id	cadeia	Esse identificador é a ID de objeto de usuário do Microsoft Entra ID (antigo Azure Active Directory) usado para autenticar usuários finais no aplicativo de IA generativa. Informações pessoais confidenciais não devem ser incluídas nesse campo.	Não
end_user_tenant_id	cadeia	A ID do locatário do Microsoft 365 à qual o usuário final pertence. Ele é necessário quando o aplicativo de IA generativa é multilocatário.	Não
source_ip	cadeia	Captura o endereço IP do cliente original.	Não

ChatCompletionMessageToolCallsItem

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

Matriz de: OpenAI.ChatCompletionMessageToolCall

CopiedAccountDetails

Nome	Tipo	Descrição	Obrigatório
destinationResourceId	cadeia	A ID do recurso de destino para o qual o modelo foi copiado.	Yes
região	cadeia	A região para a qual o modelo foi copiado.	Yes
status	enumeração	O status da operação de cópia. Valores possíveis: `Completed`, , `FailedInProgress`	Yes

CopyModelRequest

Nome	Tipo	Descrição	Obrigatório	Padrão
destinationResourceId	cadeia	A ID do recurso de destino a ser copiada.	Yes
região	cadeia	A região para a qual copiar o modelo.	Yes

CopyModelResponse

Nome	Tipo	Descrição	Obrigatório
checkpointedModelName	cadeia	A ID do modelo copiado.	Yes
copiedAccountDetails	matriz	A ID da ID do recurso de destino em que ela foi copiada	Yes
fineTuningJobId	cadeia	A ID do trabalho de ajuste fino do qual o ponto de verificação foi copiado.	Yes

ElasticsearchChatDataSource

Nome	Tipo	Descrição	Obrigatório	Padrão
parâmetros	objeto	As informações de parâmetro para controlar o uso da fonte de dados Elasticsearch.	Yes
└─ permitir_resultado_parcial	boolean	Se definido como verdadeiro, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falham. Se isso não for especificado ou especificado como falso, a solicitação falhará caso uma consulta de pesquisa falhe.	Não	Falso
└─ autenticação	objeto		Não
└─ chave_api_codificada	cadeia		Não
└─ chave	cadeia		Não
└─ key_id	cadeia		Não
└─ tipo	enumeração	Valores possíveis: `encoded_api_key`	Não
└─ embedding_dependency	AzureChatDataSourceVectorizationSource	Uma representação de uma fonte de vetorização de dados utilizável como um recurso de inserção com uma fonte de dados.	Não
└─ endpoint	cadeia		Não
└─ mapeamento_de_campos	objeto		Não
└─ campos_de_conteúdo	matriz		Não
└─ separador_dos_campos_de_conteúdo	cadeia		Não
└─ campo_caminho_do_arquivo	cadeia		Não
└─ campo_do_título	cadeia		Não
└─ campo_de_url	cadeia		Não
└─ campos_de_vetores	matriz		Não
└─ in_scope	boolean	Se as consultas devem ser restritas ao uso dos dados indexados.	Não
└─ incluir_contextos	matriz	As propriedades de contexto de saída a serem incluídas na resposta. Por padrão, as citações e a intenção serão solicitadas.	Não	['citações', 'intenções']
└─ nome_do_índice	cadeia		Não
└─ consultas_de_busca_máximas	inteiro	O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário. Por padrão, o sistema fará uma determinação automática.	Não
└─ tipo_de_consulta	enumeração	Valores possíveis: `simple`, `vector`	Não
└─ rigidez	inteiro	A rigorosidade configurada da filtragem de relevância da pesquisa. A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.	Não
└─ top_n_documents	inteiro	O número configurado de documentos a serem apresentados na consulta.	Não
tipo	enumeração	O identificador de tipo discriminado, que é sempre 'elasticsearch'. Valores possíveis: `elasticsearch`	Yes

MongoDBChatDataSource

Nome	Tipo	Descrição	Obrigatório	Padrão
parâmetros	objeto	As informações de parâmetro para controlar o uso da fonte de dados do MongoDB.	Yes
└─ permitir_resultado_parcial	boolean	Se definido como verdadeiro, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falham. Se isso não for especificado ou especificado como falso, a solicitação falhará caso uma consulta de pesquisa falhe.	Não	Falso
└─ app_name	cadeia	O nome do aplicativo MongoDB.	Não
└─ autenticação	objeto		Não
└─ senha	cadeia		Não
└─ tipo	enumeração	Valores possíveis: `username_and_password`	Não
└─ nome de usuário	cadeia		Não
└─ nome_da_colecao	cadeia	O nome da coleção do MongoDB.	Não
└─ nome_do_banco_de_dados	cadeia	O nome do banco de dados MongoDB.	Não
└─ embedding_dependency	objeto	Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de inserção do OpenAI do Azure.	Não
└─ autenticação	AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions	O mecanismo de autenticação a ser usado com a origem de vetorização baseada em ponto de extremidade. A autenticação de ponto de extremidade dá suporte a mecanismos de token de acesso e chave de API.	Não
└─ deployment_name	cadeia	A implantação do modelo de inserção a ser usada para vetorização. Essa implantação deve existir no mesmo OpenAI do Azure recurso como a implantação de modelo que está sendo usada para conclusões de chat.	Não
└─ dimensões	inteiro	O número de dimensões a serem solicitadas em inserções. Só há suporte em modelos 'text-embedding-3' e posteriores.	Não
└─ endpoint	cadeia	Especifica a URL do ponto de extremidade do recurso da qual as incorporações devem ser recuperadas. Deve estar no formato de: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. O parâmetro de consulta api-version não é permitido.	Não
└─ tipo	enumeração	O identificador de tipo, sempre 'deployment_name' para esse tipo de origem de vetorização. Valores possíveis: `deployment_name`	Não
└─ endpoint	cadeia	O nome do ponto de extremidade do cluster do Mongo DB.	Não
└─ mapeamento_de_campos	objeto	Mapeamentos de campo a serem aplicados aos dados usados pela fonte de dados do MongoDB. Observe que os mapeamentos de conteúdo e de campo de vetor são necessários para o MongoDB.	Não
└─ campos_de_conteúdo	matriz		Não
└─ separador_dos_campos_de_conteúdo	cadeia		Não
└─ campo_caminho_do_arquivo	cadeia		Não
└─ campo_do_título	cadeia		Não
└─ campo_de_url	cadeia		Não
└─ campos_de_vetores	matriz		Não
└─ in_scope	boolean	Se as consultas devem ser restritas ao uso dos dados indexados.	Não
└─ incluir_contextos	matriz	As propriedades de contexto de saída a serem incluídas na resposta. Por padrão, as citações e a intenção serão solicitadas.	Não	['citações', 'intenções']
└─ nome_do_índice	cadeia	O nome do índice MongoDB.	Não
└─ consultas_de_busca_máximas	inteiro	O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário. Por padrão, o sistema fará uma determinação automática.	Não
└─ rigidez	inteiro	A rigorosidade configurada da filtragem de relevância da pesquisa. A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.	Não
└─ top_n_documents	inteiro	O número configurado de documentos a serem apresentados na consulta.	Não
tipo	enumeração	O identificador de tipo discriminado, que é sempre 'mongo_db'. Valores possíveis: `mongo_db`	Yes

OpenAI.Annotation

Discriminador para OpenAI.Annotation

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

Valor do tipo	Esquema
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.AnnotationType		Yes

OpenAI.AnnotationFileCitation

Uma citação a um arquivo.

Nome	Tipo	Descrição	Obrigatório
file_id	cadeia	A ID do arquivo.	Yes
nome do arquivo	cadeia	O nome do arquivo citado.	Yes
indexar	inteiro	O índice do arquivo na lista de arquivos.	Yes
tipo	enumeração	O tipo da citação de arquivo. Sempre `file_citation`. Valores possíveis: `file_citation`	Yes

OpenAI.AnnotationFilePath

Um caminho para um arquivo.

Nome	Tipo	Descrição	Obrigatório
file_id	cadeia	A ID do arquivo.	Yes
indexar	inteiro	O índice do arquivo na lista de arquivos.	Yes
tipo	enumeração	O tipo do caminho do arquivo. Sempre `file_path`. Valores possíveis: `file_path`	Yes

OpenAI.AnnotationType

Propriedade	Valor
Tipo	cadeia
Valores	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

Uma citação para um recurso da Web usado para gerar uma resposta de modelo.

Nome	Tipo	Descrição	Obrigatório
end_index	inteiro	O índice do último caractere da citação de URL na mensagem.	Yes
start_index	inteiro	O índice do primeiro caractere da citação de URL na mensagem.	Yes
title	cadeia	O título do recurso da Web.	Yes
tipo	enumeração	O tipo da citação de URL. Sempre `url_citation`. Valores possíveis: `url_citation`	Yes
url	cadeia	A URL do recurso da Web.	Yes

OpenAI.ApproximateLocation

Nome	Tipo	Descrição	Obrigatório
cidade	cadeia		Não
país	cadeia		Não
região	cadeia		Não
fuso horário	cadeia		Não
tipo	enumeração	Valores possíveis: `approximate`	Yes

OpenAI.AutoChunkingStrategyRequestParam

A estratégia padrão. Atualmente, essa estratégia usa um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Yes

OpenAI.ChatCompletionFunctionCallOption

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

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

OpenAI.ChatCompletionFunctions

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.	Não
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
parâmetros		Os parâmetros aceitos pelas funções, descritos como um objeto de esquema JSON. Consulte a referência de esquema JSON para documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	Não

OpenAI.ChatCompletionMessageAudioChunk

Nome	Tipo	Obrigatório
dados	cadeia	Não
expira_em	inteiro	Não
id	cadeia	Não
transcrição	cadeia	Não

OpenAI.ChatCompletionMessageToolCall

Nome	Tipo	Descrição	Obrigatório
função	objeto	A função chamada pelo modelo.	Yes
└─ Argumentos	cadeia	Os argumentos com os quais chamar a função, conforme gerados pelo modelo no formato JSON. O modelo nem sempre gera JSON válido, e pode alucinar parâmetros não definidos pelo esquema de função. Valide os argumentos no código antes de chamar a sua função.	Não
└─ nome	cadeia	O nome da função a ser chamada.	Não
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	Descrição	Obrigatório
função	objeto		Não
└─ Argumentos	cadeia	Os argumentos com os quais chamar a função, conforme gerados pelo modelo no formato JSON. O modelo nem sempre gera JSON válido, e pode alucinar parâmetros não definidos pelo esquema de função. Valide os argumentos no código antes de chamar a sua função.	Não
└─ nome	cadeia	O nome da função a ser chamada.	Não
id	cadeia	A ID da chamada da ferramenta.	Não
indexar	inteiro		Yes
tipo	enumeração	O tipo da ferramenta. Atualmente, há suporte apenas para `function`. Valores possíveis: `function`	Não

OpenAI.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
função	objeto		Yes
└─ nome	cadeia	O nome da função a ser chamada.	Não
tipo	enumeração	O tipo da ferramenta. Atualmente, há suporte apenas para `function`. Valores possíveis: `function`	Yes

OpenAI.ChatCompletionRequestAssistantMessage

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

Nome	Tipo	Descrição	Obrigatório
audio	objeto	Dados sobre uma resposta de áudio anterior do modelo.	Não
└─ id	cadeia	Identificador exclusivo para uma resposta de áudio anterior do modelo.	Não
conteúdo	cadeia de caracteres ou matriz		Não
function_call	objeto	Preterido e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	Não
└─ Argumentos	cadeia		Não
└─ nome	cadeia		Não
nome	cadeia	Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função.	Não
recusa	cadeia	A mensagem de recusa do assistente.	Não
função	enumeração	A função do autor das mensagens, nesse caso, `assistant`. Valores possíveis: `assistant`	Yes
tool_calls	ChatCompletionMessageToolCallsItem	As chamadas de ferramenta geradas pelo modelo, como chamadas de função.	Não

OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

OpenAI.ChatCompletionRequestDeveloperMessage

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

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

OpenAI.ChatCompletionRequestFunctionMessage

Nome	Tipo	Descrição	Obrigatório
conteúdo	cadeia	O conteúdo da mensagem de função.	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:

Valor do tipo	Esquema
`system`	OpenAI.ChatCompletionRequestSystemMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Não
função	objeto	A função do autor de uma mensagem	Yes

OpenAI.ChatCompletionRequestMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestMessageContentPart

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

Valor do tipo	Esquema
`text`	OpenAI.ChatCompletionRequestMessageContentPartText
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ChatCompletionRequestMessageContentPartType		Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Nome	Tipo	Descrição	Obrigatório
input_audio	objeto		Yes
└─ dados	cadeia	Dados de áudio codificados em Base64.	Não
└─ formato	enumeração	O formato dos dados de áudio codificados. Atualmente compatível com "wav" e "mp3". Valores possíveis: `wav`, `mp3`	Não
tipo	enumeração	O tipo da parte de conteúdo. Sempre `input_audio`. Valores possíveis: `input_audio`	Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Nome	Tipo	Descrição	Obrigatório
arquivo	objeto		Yes
└─ dados_do_arquivo	cadeia	Os dados do arquivo codificado em base64, usados ao passar o arquivo para o modelo como uma cadeia de caracteres.	Não
└─ identificador_de_arquivo	cadeia	A ID de um arquivo carregado a ser usado como entrada.	Não
└─ nome do arquivo	cadeia	O nome do arquivo, usado ao passar o arquivo para o modelo como um cadeia de caracteres.	Não
tipo	enumeração	O tipo da parte de conteúdo. Sempre `file`. Valores possíveis: `file`	Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Nome	Tipo	Descrição	Obrigatório
image_url	objeto		Yes
└─ detalhe	enumeração	Especifica o nível de detalhes da imagem. Valores possíveis: `auto`, , `lowhigh`	Não
└─ URL	cadeia	Uma URL da imagem ou os dados de imagem codificados em base64.	Não
tipo	enumeração	O tipo da parte de conteúdo. Valores possíveis: `image_url`	Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

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

Propriedade	Valor
Tipo	cadeia
Valores	`text` `file` `input_audio` `image_url` `refusal`

OpenAI.ChatCompletionRequestSystemMessage

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	Descrição	Obrigatório
conteúdo	cadeia de caracteres ou matriz		Yes
nome	cadeia	Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função.	Não
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

Nome	Tipo	Descrição	Obrigatório
conteúdo	cadeia de caracteres ou matriz		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

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

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

OpenAI.ChatCompletionRequestUserMessageContentPart

Nome	Tipo	Descrição	Obrigatório
arquivo	objeto		Yes
└─ dados_do_arquivo	cadeia	Os dados do arquivo codificado em base64, usados ao passar o arquivo para o modelo como uma cadeia de caracteres.	Não
└─ identificador_de_arquivo	cadeia	A ID de um arquivo carregado a ser usado como entrada.	Não
└─ nome do arquivo	cadeia	O nome do arquivo, usado ao passar o arquivo para o modelo como um cadeia de caracteres.	Não
image_url	objeto		Yes
└─ detalhe	enumeração	Especifica o nível de detalhes da imagem. Valores possíveis: `auto`, , `lowhigh`	Não
└─ URL	cadeia	Uma URL da imagem ou os dados de imagem codificados em base64.	Não
input_audio	objeto		Yes
└─ dados	cadeia	Dados de áudio codificados em Base64.	Não
└─ formato	enumeração	O formato dos dados de áudio codificados. Atualmente compatível com "wav" e "mp3". Valores possíveis: `wav`, `mp3`	Não
enviar SMS	cadeia	O conteúdo do texto.	Yes
tipo	enumeração	O tipo da parte de conteúdo. Sempre `file`. Valores possíveis: `file`	Yes

OpenAI.ChatCompletionRole

A função do autor de uma mensagem

Propriedade	Valor
Descrição	A função do autor de uma mensagem
Tipo	cadeia
Valores	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

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

Nome	Tipo	Descrição	Obrigatório	Padrão
include_usage	boolean	Se definido, uma parte adicional será transmitida antes da `data: [DONE]` mensagem. O campo `usage` nesta parte mostra as estatísticas de uso do token para toda a solicitação, e o campo `choices` sempre será uma vazia matriz. Todas as outras partes também incluirão um campo `usage`, mas com um nulo valor. OBSERVAÇÃO: Se o fluxo for interrompido, você poderá não receber a parte de uso final que contém o uso total do token para a solicitação.	Não

OpenAI.ChatCompletionStreamResponseDelta

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

Nome	Tipo	Descrição	Obrigatório
audio	objeto		Não
└─ dados	cadeia		Não
└─ data_de_expiração	inteiro		Não
└─ id	cadeia		Não
└─ transcrição	cadeia		Não
conteúdo	cadeia	O conteúdo da mensagem de parte.	Não
function_call	objeto	Preterido e substituído por `tool_calls`. O nome e os argumentos de uma função que deve ser chamada, conforme gerados pelo modelo.	Não
└─ Argumentos	cadeia		Não
└─ nome	cadeia		Não
recusa	cadeia	A mensagem de recusa gerada pelo modelo.	Não
função	objeto	A função do autor de uma mensagem	Não
tool_calls	matriz		Não

OpenAI.ChatCompletionTokenLogprob

Nome	Tipo	Descrição	Obrigatório
bytes	matriz	Uma lista de inteiros da representação de bytes UTF-8 do token. Útil em instâncias em que os caracteres são representados por vários tokens e suas representações de bytes devem ser combinadas para gerar a representação de texto correta. Poderá ser `null` se não houver representação de bytes para o token.	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	Lista dos tokens mais prováveis e sua probabilidade de log, nessa posição de token. Em casos raros, pode haver menos do que o número de `top_logprobs` retornados solicitados.	Yes

Ferramenta de Conclusão de Chat da OpenAI

Nome	Tipo	Descrição	Obrigatório	Padrão
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 determinada ferramenta por meio de {"type": "function", "function": {"name": "my_function"}} força o modelo a chamar essa ferramenta.

none é o padrão quando não há nenhuma ferramenta presente. auto é o padrão se ferramentas estiverem presente.

Nome	Tipo	Descrição	Obrigatório
função	objeto		Yes
└─ nome	cadeia	O nome da função a ser chamada.	Não
tipo	enumeração	O tipo da ferramenta. Atualmente, há suporte apenas para `function`. Valores possíveis: `function`	Yes

OpenAI.ChatOutputPrediction

Representação base da saída prevista de um modelo.

Discriminador para OpenAI.ChatOutputPrediction

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

Valor do tipo	Esquema
`content`	OpenAI.ChatOutputPredictionContent

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ChatOutputPredictionType		Yes

OpenAI.ChatOutputPredictionContent

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

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes
tipo	enumeração	O tipo de conteúdo previsto que você deseja fornecer. Esse tipo é atualmente sempre de `content`. Valores possíveis: `content`	Yes

OpenAI.ChatOutputPredictionType

Propriedade	Valor
Tipo	cadeia
Valores	`content`

OpenAI.ChunkingStrategyRequestParam

A estratégia de divisão em partes usada para dividir os arquivos. Se não estiver definida, usará a estratégia de auto.

Discriminador do OpenAI.ChunkingStrategyRequestParam

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

Valor do tipo	Esquema
`static`	OpenAI.StaticChunkingStrategyRequestParam

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de estratégia de agrupamento. Valores possíveis: `auto`, `static`	Yes

OpenAI.ChunkingStrategyResponseParam

Discriminador para OpenAI.ChunkingStrategyResponseParam

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

Valor do tipo	Esquema
`other`	OpenAI.OtherChunkingStrategyResponseParam
`static`	OpenAI.StaticChunkingStrategyResponseParam

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `static`, `other`	Yes

OpenAI.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

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

Valor do tipo	Esquema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.CodeInterpreterOutputType		Yes

OpenAI.CodeInterpreterOutputImage

A saída da imagem do interpretador de código.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo da saída. Sempre “imagem”. Valores possíveis: `image`	Yes
url	cadeia	A URL da saída da imagem do interpretador de código.	Yes

OpenAI.CodeInterpreterOutputLogs

A saída de logs do interpretador de código.

Nome	Tipo	Descrição	Obrigatório	Padrão
logs	cadeia	A saída de logs do interpretador de código.	Yes
tipo	enumeração	O tipo da saída. Sempre “logs”. Valores possíveis: `logs`	Yes

OpenAI.CodeInterpreterOutputType

Propriedade	Valor
Tipo	cadeia
Valores	`logs` `image`

OpenAI.CodeInterpreterTool

Uma ferramenta que executa o código Python para ajudar a gerar uma resposta a um prompt.

Nome	Tipo	Descrição	Obrigatório
contêiner	objeto	Configuração para um contêiner de interpretador de código. Especifique os identificadores opcionalmente dos arquivos em que executar o código.	Yes
└─ file_ids (identificadores de arquivo)	matriz	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código.	Não
└─ tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Não
tipo	enumeração	O tipo da ferramenta de interpretador de código. Sempre `code_interpreter`. Valores possíveis: `code_interpreter`	Yes

OpenAI.CodeInterpreterToolAuto

Configuração para um contêiner de interpretador de código. Opcionalmente, especifique as IDs dos arquivos nos quais executar o código.

Nome	Tipo	Descrição	Obrigatório	Padrão
identificadores_de_arquivos	matriz	Uma lista opcional de arquivos carregados a serem disponibilizados para seu código.	Não
tipo	enumeração	Sempre `auto`. Valores possíveis: `auto`	Yes

OpenAI.CodeInterpreterToolCallItemParam

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Descrição	Obrigatório
codificar	cadeia	O código a ser executado ou nulo se não estiver disponível.	Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
saídas	matriz	As saídas geradas pelo interpretador de código, como logs ou imagens. Pode ser nulo se nenhuma saída estiver disponível.	Yes
tipo	enumeração	Valores possíveis: `code_interpreter_call`	Yes

OpenAI.CodeInterpreterToolCallItemResource

Uma chamada de ferramenta para executar o código.

Nome	Tipo	Descrição	Obrigatório
codificar	cadeia	O código a ser executado ou nulo se não estiver disponível.	Yes
container_id	cadeia	A ID do contêiner usado para executar o código.	Yes
saídas	matriz	As saídas geradas pelo interpretador de código, como logs ou imagens. Pode ser nulo se nenhuma saída estiver disponível.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completed`, `incomplete`, `interpreting`, `failed`	Yes
tipo	enumeração	Valores possíveis: `code_interpreter_call`	Yes

OpenAI.FiltroComparativo

Um filtro usado para comparar uma chave de atributo especificada com um determinado valor usando uma operação de comparação definida.

Nome	Tipo	Descrição	Obrigatório
chave	cadeia	A chave a ser comparada com o valor.	Yes
tipo	enumeração	Especifica o operador de comparação: `eq`, , `ne`, `gt`, `gte`, `lt`, `lte`. - `eq`: igual - `ne`: não é igual a - `gt`: maior que - `gte`: maior ou igual a - `lt`: menor que - `lte`: menor ou igual a Valores possíveis: `eq`, , `ne`, `gt`, `gte`, , `ltlte`	Yes
value	cadeia de caracteres ou número ou booleano		Yes

OpenAI.CompletionUsage

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

Nome	Tipo	Descrição	Obrigatório	Padrão
completion_tokens	inteiro	Número de tokens na conclusão gerada.	Yes	0
completion_tokens_details	objeto	Divisão de tokens usados em uma conclusão.	Não
└─ tokens_de_predição_aceitos	inteiro	Ao usar saídas previstas, o número de tokens na previsão que apareceu na conclusão.	Não	0
└─ audio_tokens	inteiro	Tokens de entrada de áudio gerados pelo modelo.	Não	0
└─ tokens_de_raciocínio	inteiro	Tokens gerados pelo modelo para raciocínio.	Não	0
└─ rejected_prediction_tokens	inteiro	Ao usar saídas previstas, o número de tokens na previsão que não apareceu na conclusão. No entanto, assim como os tokens de raciocínio, esses tokens ainda são contabilizados no total de tokens de conclusão para fins de cobrança, saída e limites da janela de contexto.	Não	0
prompt_tokens	inteiro	Número de tokens no prompt.	Yes	0
prompt_tokens_details	objeto	Divisão de tokens usados na solicitação.	Não
└─ audio_tokens	inteiro	Tokens de entrada de áudio presentes na solicitação.	Não	0
└─ tokens em cache	inteiro	Tokens armazenados em cache presentes no prompt.	Não	0
total_tokens	inteiro	Número total de tokens utilizados na solicitação (prompt + conclusão).	Yes	0

OpenAI.CompoundFilter

Combinar vários filtros usando and ou or.

Nome	Tipo	Descrição	Obrigatório	Padrão
filters	matriz	Matriz de filtros a serem combinados. Os itens podem ser `ComparisonFilter` ou `CompoundFilter`.	Yes
tipo	enumeração	Tipo de operação: `and` ou `or`. Valores possíveis: `and`, `or`	Yes

OpenAI.ComputerAction

Discriminador para OpenAI.ComputerAction

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

Valor do tipo	Esquema
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionClick

Uma ação de clique.

Nome	Tipo	Descrição	Obrigatório
botão	enumeração	Indica qual botão do mouse foi pressionado durante o clique. Um de `left`, `right`, `wheel`, `back` ou `forward`. Valores possíveis: `left`, , `right`, `wheel`, `back`, `forward`	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique, essa propriedade é sempre defina como `click`. Valores possíveis: `click`	Yes
x	inteiro	A coordenada X em que o clique ocorreu.	Yes
y	inteiro	A coordenada Y em que o clique ocorreu.	Yes

OpenAI.ComputerActionDoubleClick

Uma ação de clique duplo.

Nome	Tipo	Descrição	Obrigatório
tipo	enumeração	Especifica o tipo de evento. Para uma ação de clique duplo, essa propriedade é sempre defina como `double_click`. Valores possíveis: `double_click`	Yes
x	inteiro	A coordenada X em que o clique duplo ocorreu.	Yes
y	inteiro	A coordenada Y em que o clique duplo ocorreu.	Yes

OpenAI.ComputerActionDrag

Uma ação de arrastar.

Nome	Tipo	Descrição	Obrigatório	Padrão
caminho	matriz	Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas serão exibidas como uma matriz de objetos, por exemplo `<br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>`	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de arrastar, essa propriedade é sempre defina como `drag`. Valores possíveis: `drag`	Yes

OpenAI.ComputerActionKeyPress

Uma coleção de pressionamentos de teclas que o modelo gostaria de executar.

Nome	Tipo	Descrição	Obrigatório	Padrão
keys	matriz	A combinação de teclas que o modelo está solicitando que sejam pressionadas. Este é um matriz de cadeias de caracteres, cada uma representando uma chave.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação keypress, essa propriedade é sempre defina como `keypress`. Valores possíveis: `keypress`	Yes

OpenAI.ComputerActionMove

Uma ação de movimentação do mouse.

Nome	Tipo	Descrição	Obrigatório
tipo	enumeração	Especifica o tipo de evento. Para uma ação de movimentação, essa propriedade é sempre defina como `move`. Valores possíveis: `move`	Yes
x	inteiro	A coordenada x para a qual mover.	Yes
y	inteiro	A coordenada y para a qual mover.	Yes

OpenAI.ComputerActionScreenshot

Uma ação de captura de tela.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Especifica o tipo de evento. Para uma ação de captura de tela, essa propriedade é sempre defina como `screenshot`. Valores possíveis: `screenshot`	Yes

OpenAI.ComputerActionScroll

Uma ação de rolagem.

Nome	Tipo	Descrição	Obrigatório
scroll_x	inteiro	A distância de rolagem horizontal.	Yes
scroll_y	inteiro	A distância de rolagem vertical.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de rolagem, essa propriedade é sempre defina como `scroll`. Valores possíveis: `scroll`	Yes
x	inteiro	A coordenada x em que a rolagem ocorreu.	Yes
y	inteiro	A coordenada y em que a rolagem ocorreu.	Yes

OpenAI.ComputerActionType

Propriedade	Valor
Tipo	cadeia
Valores	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

Uma ação para digitar texto.

Nome	Tipo	Descrição	Obrigatório	Padrão
enviar SMS	cadeia	O texto a ser digitado.	Yes
tipo	enumeração	Especifica o tipo de evento. Para uma ação de tipo, essa propriedade é sempre defina como `type`. Valores possíveis: `type`	Yes

OpenAI.ComputerActionWait

Uma ação de espera.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Especifica o tipo de evento. Para uma ação de espera, essa propriedade é sempre defina como `wait`. Valores possíveis: `wait`	Yes

OpenAI.ComputerToolCallItemParam

Uma chamada de ferramenta para uma ferramenta de uso de computador.

Nome	Tipo	Descrição	Obrigatório
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
pending_safety_checks	matriz	As verificações de segurança pendentes para a chamada de computador.	Yes
tipo	enumeração	Valores possíveis: `computer_call`	Yes

OpenAI.ComputerToolCallItemResource

Uma chamada de ferramenta para uma ferramenta de uso de computador.

Nome	Tipo	Descrição	Obrigatório
ação	OpenAI.ComputerAction		Yes
call_id	cadeia	Um identificador usado ao responder à chamada de ferramenta com saída.	Yes
pending_safety_checks	matriz	As verificações de segurança pendentes para a chamada de computador.	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	Valores possíveis: `computer_call`	Yes

OpenAI.ComputerToolCallOutputItemOutput

Discriminador para OpenAI.ComputerToolCallOutputItemOutput

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

Valor do tipo	Esquema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ComputerToolCallOutputItemOutputType	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.	Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nome	Tipo	Descrição	Obrigatório
file_id	cadeia		Não
image_url	cadeia		Não
tipo	enumeração	Valores possíveis: `computer_screenshot`	Yes

OpenAI.ComputerToolCallOutputItemOutputType

Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.

Propriedade	Valor
Descrição	Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.
Tipo	cadeia
Valores	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	Descrição	Obrigatório
acknowledged_safety_checks	matriz	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	Não
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Yes
saída	OpenAI.ComputerToolCallOutputItemOutput		Yes
tipo	enumeração	Valores possíveis: `computer_call_output`	Yes

OpenAI.ComputerToolCallOutputItemResource

A saída de uma chamada de ferramenta de computador.

Nome	Tipo	Descrição	Obrigatório
acknowledged_safety_checks	matriz	As verificações de segurança relatadas pela API que foram confirmadas pela desenvolvedor.	Não
call_id	cadeia	A ID da chamada da ferramenta de computador que produziu a saída.	Yes
saída	OpenAI.ComputerToolCallOutputItemOutput		Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	Valores possíveis: `computer_call_output`	Yes

OpenAI.ComputerToolCallSafetyCheck

Uma verificação de segurança pendente para a chamada de computador.

Nome	Tipo	Descrição	Obrigatório
codificar	cadeia	O tipo da verificação de segurança pendente.	Yes
id	cadeia	A ID da verificação de segurança pendente.	Yes
mensagem	cadeia	Detalhes sobre a verificação de segurança pendente.	Yes

OpenAI.ComputerUsePreviewTool

Uma ferramenta que controla um computador virtual.

Nome	Tipo	Descrição	Obrigatório
altura_do_display	inteiro	A altura da exibição do computador.	Yes
largura de exibição	inteiro	A largura da exibição do computador.	Yes
ambiente	enumeração	O tipo de ambiente de computador a ser controlado. Valores possíveis: `windows`, , `mac`, `linux`, `ubuntu`, `browser`	Yes
tipo	enumeração	O tipo da ferramenta de uso do computador. Sempre `computer_use_preview`. Valores possíveis: `computer_use_preview`	Yes

OpenAI.Coordinate

Um par de coordenadas x/y, por exemplo. { x: 100, y: 200 }.

Nome	Tipo	Descrição	Obrigatório	Padrão
x	inteiro	A coordenada X.	Yes
y	inteiro	A coordenada Y.	Yes

OpenAI.CreateEmbeddingResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz	A lista de incorporações geradas pelo modelo.	Yes
modelo	cadeia	O nome do modelo usado para gerar a incorporação.	Yes
objeto	enumeração	O tipo de objeto, que é sempre "lista". Valores possíveis: `list`	Yes
uso	objeto	As informações de uso da solicitação.	Yes
└─ prompt_tokens	inteiro	O número de tokens usados pelo prompt.	Não
└─ total_tokens	inteiro	O número total de tokens usados pela solicitação.	Não

OpenAI.CreateEvalItem

Uma mensagem de chat que compõe o prompt ou contexto. Pode incluir referências variáveis ao namespace item, ou seja, {{item.name}}.

Nome	Tipo	Descrição	Obrigatório
conteúdo	cadeia de caracteres OpenAI.EvalItemContent	Entradas de texto para o modelo – podem conter cadeias de caracteres de modelo.	Yes
função	enumeração	A função da entrada de mensagem. Um de `user`, `assistant`, `system` ou `developer`. Valores possíveis: `user`, , `assistant`, `systemdeveloper`	Yes
tipo	enumeração	O tipo de entrada da mensagem. Sempre `message`. Valores possíveis: `message`	Não

OpenAI.CreateEvalRunRequest

Nome	Tipo	Descrição	Obrigatório
fonte_de_dados	objeto		Yes
└─ tipo	OpenAI.EvalRunDataSourceType		Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome da execução.	Não

OpenAI.CreateFineTuningJobRequest

Modelos válidos:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Nome	Tipo	Descrição	Obrigatório	Padrão
hiperparâmetros	objeto	Os hiperparâmetros usados no trabalho de ajuste fino. Agora, esse valor foi preterido em favor de `method`, e deve ser passado sob o parâmetro `method`.	Não
└─ tamanho_do_lote (batch_size)	enumeração	Valores possíveis: `auto`	Não
└─ multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
└─ n_epochs	enumeração	Valores possíveis: `auto`	Não
Integrações	matriz	Uma lista de integrações para habilitar seu trabalho de ajuste fino.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
método	OpenAI.FineTuneMethod	O método usado no ajuste fino.	Não
modelo	cadeia de caracteres (veja os modelos válidos abaixo)	O nome do modelo a ser refinado. Você pode selecionar um dos modelos com suporte.	Yes
semente	inteiro	A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros iniciais e de trabalho deve produzir os mesmos resultados, mas pode diferir em casos raros. Se uma semente não for especificada, uma será gerada para você.	Não
sufixo	cadeia	Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado. Por exemplo, um `suffix` "custom-model-name" produz um nome de modelo como `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`.	Não	Nenhum
arquivo_de_treinamento	cadeia	A ID de um arquivo carregado que contém os dados de treinamento. Consulte carregar arquivo para saber como carregar um arquivo. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade `fine-tune`. O conteúdo do arquivo deve ser diferente dependendo se o modelo usa o chat ou se o método de ajuste fino usa o formato de preferência. Consulte o guia de ajuste fino para obter mais detalhes.	Yes
arquivo_de_validação	cadeia	A ID de um arquivo carregado que contém os dados de validação. Se você fornecer esse arquivo, os dados serão usados para gerar validação métricas periódicas durante o ajuste fino. Essas métricas podem ser exibidas em o arquivo de resultados de ajuste fino. Os mesmos dados não devem estar presentes nos arquivos de treinamento e validação. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade `fine-tune`. Consulte o guia de ajuste fino para obter mais detalhes.	Não

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Valor do tipo	Esquema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	cadeia de caracteres (veja os modelos válidos abaixo)		Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome	Tipo	Descrição	Obrigatório
tipo	enumeração	Valores possíveis: `wandb`	Yes
wandb	objeto		Yes
└─ entidade	cadeia		Não
└─ nome	cadeia		Não
└─ projeto	cadeia		Não
└─ etiquetas	matriz		Não

OpenAI.CreateVectorStoreFileBatchRequest

Nome	Tipo	Descrição	Obrigatório
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Não
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	A estratégia de divisão em partes usada para dividir os arquivos. Se não estiver definida, usará a estratégia de `auto`.	Não
identificadores_de_arquivos	matriz	Uma lista de IDs de Arquivo que o repositório de vetores deve usar. Útil para ferramentas como `file_search`, que podem acessar arquivos.	Yes

OpenAI.CreateVectorStoreFileRequest

Nome	Tipo	Descrição	Obrigatório
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Não
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	A estratégia de divisão em partes usada para dividir os arquivos. Se não estiver definida, usará a estratégia de `auto`.	Não
file_id	cadeia	Uma ID de arquivo que o repositório de vetores deve usar. Útil para ferramentas como `file_search`, que podem acessar arquivos.	Yes

OpenAI.CreateVectorStoreRequest

Nome	Tipo	Descrição	Obrigatório
chunking_strategy	objeto	A estratégia padrão. Atualmente, essa estratégia usa um `max_chunk_size_tokens` de `800` e `chunk_overlap_tokens` de `400`.	Não
└─ estático	OpenAI.StaticChunkingStrategy		Não
└─ tipo	enumeração	Sempre `static`. Valores possíveis: `static`	Não
expires_after	OpenAI.VectorStoreExpirationAfter	A política de expiração de um repositório de vetores.	Não
identificadores_de_arquivos	matriz	Uma lista de IDs de Arquivo que o repositório de vetores deve usar. Útil para ferramentas como `file_search`, que podem acessar arquivos.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome do repositório de vetores.	Não

OpenAI.DeleteFileResponse

Nome	Tipo	Descrição	Obrigatório
excluído	boolean		Yes
id	cadeia		Yes
objeto	enumeração	Valores possíveis: `file`	Yes

OpenAI.DeleteVectorStoreFileResponse

Nome	Tipo	Descrição	Obrigatório
excluído	boolean		Yes
id	cadeia		Yes
objeto	enumeração	Valores possíveis: `vector_store.file.deleted`	Yes

OpenAI.DeleteVectorStoreResponse

Nome	Tipo	Descrição	Obrigatório
excluído	boolean		Yes
id	cadeia		Yes
objeto	enumeração	Valores possíveis: `vector_store.deleted`	Yes

OpenAI.Embedding

Representa um vetor de inserção retornado inserindo o ponto de extremidade.

Nome	Tipo	Descrição	Obrigatório
Inserção	matriz ou cadeia de caracteres		Yes
indexar	inteiro	O índice da inserção na lista de inserções.	Yes
objeto	enumeração	O tipo de objeto, que é sempre de “inserção”. Valores possíveis: `embedding`	Yes

OpenAI.Eval

Um objeto Eval com critérios de teste e configuração de fonte de dados. Uma avaliação representa uma tarefa a ser concluída na sua integração de LLM. Assim como:

Melhorar a qualidade do meu chatbot
Veja como meu chatbot lida bem com o suporte ao cliente
Verifique se o4-mini é melhor para o meu caso de uso do que gpt-4o.

Nome	Tipo	Descrição	Obrigatório	Padrão
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da criação da avaliação.	Yes
configuração_da_fonte_de_dados	objeto		Yes
└─ tipo	OpenAI.EvalDataSourceConfigType		Não
id	cadeia	Identificador exclusivo para a avaliação.	Yes
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
nome	cadeia	O nome da avaliação.	Yes
objeto	enumeração	O tipo de objeto. Valores possíveis: `eval`	Yes
critérios_de_teste	matriz	Uma lista de critérios de teste.	Yes	Nenhum

OpenAI.EvalApiError

Um objeto que representa uma resposta de erro da API de Eval.

Nome	Tipo	Descrição	Obrigatório	Padrão
codificar	cadeia	O código do erro.	Yes
mensagem	cadeia	A mensagem de erro.	Yes

OpenAI.EvalCompletionsRunDataSourceParams

Um objeto CompletionsRunDataSource que descreve uma configuração de amostragem de modelo.

Nome	Tipo	Descrição	Obrigatório
mensagens_de_entrada	objeto		Não
└─ item_reference	cadeia	Uma referência a uma variável no namespace `item`. Ou seja, "item.input_trajectory"	Não
└─ modelo	matriz	Uma lista de mensagens de chat que formam o prompt ou o contexto. Pode incluir referências variáveis ao namespace `item`, ou seja, {{item.name}}.	Não
└─ tipo	enumeração	O tipo de mensagens de entrada. Sempre `item_reference`. Valores possíveis: `item_reference`	Não
modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
sampling_params	AzureEvalAPICompletionsSamplingParams		Não
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ criado_depois	inteiro	Um carimbo de data/hora Unix opcional para filtrar os itens criados após esse horário.	Não
└─ criado_antes	inteiro	Um carimbo de data/hora Unix opcional para filtrar itens criados antes desse horário.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ limite	inteiro	Um número máximo opcional de itens a serem retornados.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	Um modelo opcional para filtrar (por exemplo, 'gpt-4o').	Não
└─ tipo	enumeração	O tipo de origem. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Não
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `completions`. Valores possíveis: `completions`	Yes

OpenAI.EvalCustomDataSourceConfigParams

Um objeto CustomDataSourceConfig que define o esquema da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão:

Usados para definir seus critérios de teste e
Quais dados são necessários ao criar uma execução

Nome	Tipo	Descrição	Obrigatório	Padrão
incluir_esquema_exemplo	boolean	Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas a partir da sua fonte de dados)	Não	Falso
esquema_de_item	objeto	O esquema json para cada linha na fonte de dados.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `custom`. Valores possíveis: `custom`	Yes

OpenAI.EvalCustomDataSourceConfigResource

Um CustomDataSourceConfig que especifica o esquema dos seus namespaces item e, opcionalmente, sample. O esquema de resposta define a forma dos dados que serão:

Usados para definir seus critérios de teste e
Quais dados são necessários ao criar uma execução

Nome	Tipo	Descrição	Obrigatório	Padrão
esquema	objeto	O esquema JSON para os itens da fonte de dados de execução. Saiba como criar esquemas JSON aqui.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `custom`. Valores possíveis: `custom`	Yes

OpenAI.EvalDataSourceConfigParams

Discriminador para OpenAI.EvalDataSourceConfigParams

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

Valor do tipo	Esquema
`custom`	OpenAI.EvalCustomDataSourceConfigParams
`logs`	OpenAI.EvalLogsDataSourceConfigParams
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigResource

Discriminador para OpenAI.EvalDataSourceConfigResource

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

Valor do tipo	Esquema
`custom`	OpenAI.EvalCustomDataSourceConfigResource
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigResource
`logs`	OpenAI.EvalLogsDataSourceConfigResource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigType

Propriedade	Valor
Tipo	cadeia
Valores	`custom` `logs` `stored_completions`

OpenAI.EvalGraderLabelModelParams

Um objeto LabelModelGrader que usa um modelo para atribuir rótulos a cada item na avaliação.

Nome	Tipo	Descrição	Obrigatório
entrada	matriz	Uma lista de mensagens de chat que formam o prompt ou o contexto. Pode incluir referências variáveis ao namespace `item`, ou seja, {{item.name}}.	Yes
rótulos	matriz	Os rótulos para classificar cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Yes

OpenAI.EvalGraderLabelModelResource

Nome	Tipo	Descrição	Obrigatório
entrada	matriz		Yes
rótulos	matriz	Os rótulos a serem atribuídos a cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Yes

OpenAI.EvalGraderParams

Discriminador para OpenAI.EvalGraderParams

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

Valor do tipo	Esquema
`label_model`	OpenAI.EvalGraderLabelModelParams
`string_check`	OpenAI.EvalGraderStringCheckParams
`text_similarity`	OpenAI.EvalGraderTextSimilarityParams
`python`	OpenAI.EvalGraderPythonParams
`score_model`	OpenAI.EvalGraderScoreModelParams

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.GraderType		Yes

OpenAI.EvalGraderPythonParams

Nome	Tipo	Descrição	Obrigatório
image_tag	cadeia	A marca da imagem a ser usada no script python.	Não
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	número	O limite para a pontuação.	Não
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `python`. Valores possíveis: `python`	Yes

OpenAI.EvalGraderPythonResource

Nome	Tipo	Descrição	Obrigatório
image_tag	cadeia	A marca da imagem a ser usada no script python.	Não
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	número	O limite para a pontuação.	Não
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `python`. Valores possíveis: `python`	Yes

OpenAI.EvalGraderResource

Discriminador para OpenAI.EvalGraderResource

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

Valor do tipo	Esquema
`label_model`	OpenAI.EvalGraderLabelModelResource
`text_similarity`	OpenAI.EvalGraderTextSimilarityResource
`python`	OpenAI.EvalGraderPythonResource
`score_model`	OpenAI.EvalGraderScoreModelResource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.GraderType		Yes

OpenAI.EvalGraderScoreModelParams

Nome	Tipo	Descrição	Obrigatório
entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	número	O limite para a pontuação.	Não
alcance	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
sampling_params		Os parâmetros de amostragem do modelo.	Não
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Yes

OpenAI.EvalGraderScoreModelResource

Nome	Tipo	Descrição	Obrigatório
entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	número	O limite para a pontuação.	Não
alcance	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
sampling_params		Os parâmetros de amostragem do modelo.	Não
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Yes

OpenAI.EvalGraderStringCheckParams

Nome	Tipo	Descrição	Obrigatório
entrada	cadeia	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia	O nome do avaliador.	Yes
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Yes
referência	cadeia	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `string_check`. Valores possíveis: `string_check`	Yes

OpenAI.EvalGraderTextSimilarityParams

Nome	Tipo	Descrição	Obrigatório
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	número	O limite para a pontuação.	Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: `text_similarity`	Yes

OpenAI.EvalGraderTextSimilarityResource

Nome	Tipo	Descrição	Obrigatório
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
limite_de_passagem	número	O limite para a pontuação.	Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: `text_similarity`	Yes

OpenAI.EvalItem

Uma mensagem de entrada para o modelo com uma função que indica a hierarquia de instruções a seguir. As instruções fornecidas com a função developer ou system têm precedência sobre as instruções fornecidas com a função user. Presume-se que as mensagens com a assistant função tenham sido geradas pelo modelo em interações anteriores.

Nome	Tipo	Descrição	Obrigatório
conteúdo	objeto		Yes
└─ tipo	OpenAI.EvalItemContentType		Não
função	enumeração	A função da entrada de mensagem. Um de `user`, `assistant`, `system` ou `developer`. Valores possíveis: `user`, , `assistant`, `systemdeveloper`	Yes
tipo	enumeração	O tipo de entrada da mensagem. Sempre `message`. Valores possíveis: `message`	Não

OpenAI.EvalItemContent

Discriminador para OpenAI.EvalItemContent

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

Valor do tipo	Esquema
`input_text`	OpenAI.EvalItemContentInputText
`output_text`	OpenAI.EvalItemContentOutputText

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.EvalItemContentType		Yes

OpenAI.EvalItemContentInputText

Nome	Tipo	Descrição	Obrigatório	Padrão
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: `input_text`	Yes

OpenAI.EvalItemContentOutputText

Nome	Tipo	Descrição	Obrigatório	Padrão
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: `output_text`	Yes

OpenAI.EvalItemContentType

Propriedade	Valor
Tipo	cadeia
Valores	`input_text` `output_text`

OpenAI.EvalJsonlRunDataSourceParams

Um objeto JsonlRunDataSource com o qual especifica um arquivo JSONL que corresponde à avaliação

Nome	Tipo	Descrição	Obrigatório
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ tipo	enumeração	Tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Não
tipo	enumeração	O tipo de fonte de dados. Sempre `jsonl`. Valores possíveis: `jsonl`	Yes

OpenAI.EvalList

Um objeto que representa uma lista de valores.

Nome	Tipo	Descrição	Obrigatório
dados	matriz	Uma matriz de objetos de avaliação.	Yes
first_id	cadeia	O identificador da primeira avaliação na matriz de dados.	Yes
has_more	boolean	Indica se há mais avaliações disponíveis.	Yes
last_id	cadeia	O identificador da última avaliação na matriz de dados.	Yes
objeto	enumeração	O tipo desse objeto. Ele é sempre definido como "lista". Valores possíveis: `list`	Yes

OpenAI.EvalLogsDataSourceConfigParams

Uma configuração de fonte de dados que especifica a propriedade dos metadados da consulta de logs. Geralmente, são metadados como usecase=chatbot ou prompt-version=v2etc.

Nome	Tipo	Descrição	Obrigatório	Padrão
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
tipo	enumeração	O tipo de fonte de dados. Sempre `logs`. Valores possíveis: `logs`	Yes

OpenAI.EvalLogsDataSourceConfigResource

Um LogsDataSourceConfig que especifica a propriedade de metadados da consulta de logs. Geralmente, são metadados como usecase=chatbot ou prompt-version=v2etc. O esquema retornado por essa configuração de fonte de dados é usado para definir quais variáveis estão disponíveis em suas avaliações. item e sample ambos são definidos ao usar essa configuração de fonte de dados.

Nome	Tipo	Descrição	Obrigatório
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
esquema	objeto	O esquema JSON para os itens da fonte de dados de execução. Saiba como criar esquemas JSON aqui.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `logs`. Valores possíveis: `logs`	Yes

OpenAI.EvalResponsesRunDataSourceParams

Um objeto ResponsesRunDataSource que descreve uma configuração de amostragem de modelo.

Nome	Tipo	Descrição	Obrigatório
mensagens_de_entrada	objeto		Não
└─ item_reference	cadeia	Uma referência a uma variável no namespace `item`. Ou seja, "item.name"	Não
└─ modelo	matriz	Uma lista de mensagens de chat que formam o prompt ou o contexto. Pode incluir referências variáveis ao namespace `item`, ou seja, {{item.name}}.	Não
└─ tipo	enumeração	O tipo de mensagens de entrada. Sempre `item_reference`. Valores possíveis: `item_reference`	Não
modelo	cadeia	O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini").	Não
sampling_params	AzureEvalAPIResponseSamplingParams		Não
fonte	objeto		Yes
└─ conteúdo	matriz	O conteúdo do arquivo jsonl.	Não
└─ criado_depois	inteiro	Inclua somente itens criados após esse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ criado_antes	inteiro	Inclua somente itens criados antes desse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ id	cadeia	O identificador do arquivo.	Não
└─ instruções_busca	cadeia	Cadeia de caracteres opcional para pesquisar o campo “instruções”. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ modelo	cadeia	O nome do modelo para o qual se quer encontrar respostas. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ esforço_de_raciocínio	Esforço de Raciocínio da OpenAI	Parâmetro de esforço de raciocínio opcional. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ temperatura	número	Temperatura de amostragem. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ ferramentas	matriz	Lista de nomes de ferramentas. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ top_p	número	Parâmetro de amostragem de núcleo. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
└─ tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Não
└─ usuários	matriz	Lista de identificadores de usuário. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Yes

OpenAI.EvalRun

Um esquema que representa um processo de avaliação.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	Carimbo de data/hora Unix (em segundos) da criação da execução de avaliação.	Yes
fonte_de_dados	objeto		Yes
└─ tipo	OpenAI.EvalRunDataSourceType		Não
erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Yes
eval_id	cadeia	O identificador da avaliação associada.	Yes
id	cadeia	Identificador exclusivo para a execução da avaliação.	Yes
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia	O modelo que é avaliado, se aplicável.	Yes
nome	cadeia	O nome da execução da avaliação.	Yes
objeto	enumeração	O tipo do objeto. Sempre "eval.run". Valores possíveis: `eval.run`	Yes
per_model_usage	matriz	Estatísticas de uso para cada modelo durante a execução da avaliação.	Yes
resultados_por_critério_de_teste	matriz	Resultados por critérios de teste aplicados durante a execução da avaliação.	Yes
report_url	cadeia	A URL para o relatório da execução da avaliação no painel da interface do usuário.	Yes
contagem_de_resultados	objeto	Contadores que resumem os resultados da execução da avaliação.	Yes
└─ erro	inteiro	Número de itens de saída que resultaram em um erro.	Não
└─ falha	inteiro	Número de itens de saída que não passaram na avaliação.	Não
└─ aprovado	inteiro	Número de itens de saída que passaram na avaliação.	Não
└─ total	inteiro	Número total de itens de saída executados.	Não
status	cadeia	O status da execução da avaliação.	Yes

OpenAI.EvalRunDataContentSource

Discriminador para OpenAI.EvalRunDataContentSource

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

Valor do tipo	Esquema
`file_id`	OpenAI.EvalRunFileIdDataContentSource
`stored_completions`	OpenAI.EvalRunStoredCompletionsDataContentSource
`responses`	OpenAI.EvalRunResponsesDataContentSource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.EvalRunDataContentSourceType		Yes

OpenAI.EvalRunDataContentSourceType

Propriedade	Valor
Tipo	cadeia
Valores	`file_id` `file_content` `stored_completions` `responses`

OpenAI.EvalRunDataSourceCompletionsResource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `completions`	Yes

OpenAI.EvalRunDataSourceJsonlResource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `jsonl`	Yes

OpenAI.EvalRunDataSourceParams

Discriminador para OpenAI.EvalRunDataSourceParams

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

Valor do tipo	Esquema
`jsonl`	OpenAI.EvalJsonlRunDataSourceParams
`completions`	OpenAI.EvalCompletionsRunDataSourceParams
`responses`	OpenAI.EvalResponsesRunDataSourceParams

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResponsesResource

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `responses`	Yes

OpenAI.EvalRunDataSourceType

Propriedade	Valor
Tipo	cadeia
Valores	`jsonl` `completions` `responses`

OpenAI.EvalRunFileContentDataContentSource

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo do arquivo jsonl.	Yes
tipo	enumeração	Tipo de fonte jsonl. Sempre `file_content`. Valores possíveis: `file_content`	Yes

OpenAI.EvalRunFileIdDataContentSource

Nome	Tipo	Descrição	Obrigatório	Padrão
id	cadeia	O identificador do arquivo.	Yes
tipo	enumeração	Tipo de fonte jsonl. Sempre `file_id`. Valores possíveis: `file_id`	Yes

OpenAI.EvalRunList

Um objeto que representa uma lista de execuções para uma avaliação.

Nome	Tipo	Descrição	Obrigatório
dados	matriz	Uma matriz de objetos de execução de avaliação.	Yes
first_id	cadeia	O identificador da primeira execução de avaliação na matriz de dados.	Yes
has_more	boolean	Indica se há mais avaliações disponíveis.	Yes
last_id	cadeia	O identificador da última execução de avaliação na matriz de dados.	Yes
objeto	enumeração	O tipo desse objeto. Ele é sempre definido como "lista". Valores possíveis: `list`	Yes

OpenAI.EvalRunOutputItem

Um esquema que representa um item de saída de um processo de avaliação.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	Carimbo de data/hora Unix (em segundos) da criação da execução de avaliação.	Yes
datasource_item	objeto	Detalhes do item da fonte de dados de entrada.	Yes
identificador_do_item_da_fonte_de_dados	inteiro	O identificador do item da fonte de dados.	Yes
eval_id	cadeia	O identificador do grupo de avaliação.	Yes
id	cadeia	Identificador exclusivo para o item de saída da execução da avaliação.	Yes
objeto	enumeração	O tipo do objeto. Sempre "eval.run.output_item". Valores possíveis: `eval.run.output_item`	Yes
Resultados	matriz	Uma lista de resultados do processo de avaliação.	Yes
run_id	cadeia	O identificador da execução de avaliação associada a este item de saída.	Yes
amostra	objeto	Uma amostra contendo a entrada e a saída da execução da avaliação.	Yes
└─ erro	OpenAI.EvalApiError	Um objeto que representa uma resposta de erro da API de Eval.	Não
└─ motivo_de_conclusão	cadeia	O motivo pelo qual a geração da amostra foi concluída.	Não
└─ entrada	matriz	Uma matriz de mensagens de entrada.	Não
└─ max_completion_tokens (máximo de tokens de conclusão)	inteiro	O número máximo de tokens permitido para conclusão.	Não
└─ modelo	cadeia	O modelo usado para gerar o exemplo.	Não
└─ saída	matriz	Uma matriz de mensagens de saída.	Não
└─ semente	inteiro	A semente usada para gerar a amostra.	Não
└─ temperatura	número	A temperatura de amostragem usada.	Não
└─ top_p	número	O valor top_p usado para amostragem.	Não
└─ uso	objeto	Detalhes de uso do token para o exemplo.	Não
└─ tokens em cache	inteiro	O número de tokens recuperados do cache.	Não
└─ completion_tokens	inteiro	O número de tokens de conclusão gerados.	Não
└─ prompt_tokens	inteiro	O número de tokens de prompt usados.	Não
└─ total_tokens	inteiro	O número total de tokens usados.	Não
status	cadeia	O status da execução da avaliação.	Yes

OpenAI.EvalRunOutputItemList

Um objeto que representa uma lista de itens de saída para uma execução de avaliação.

Nome	Tipo	Descrição	Obrigatório
dados	matriz	Uma matriz de objetos de item de saída de execução de avaliação.	Yes
first_id	cadeia	O identificador do primeiro item de saída da execução de avaliação na matriz de dados.	Yes
has_more	boolean	Indica se há mais itens de saída de execução de avaliação disponíveis.	Yes
last_id	cadeia	O identificador do último item de saída da execução de avaliação na matriz de dados.	Yes
objeto	enumeração	O tipo desse objeto. Ele é sempre definido como "lista". Valores possíveis: `list`	Yes

OpenAI.EvalRunResponsesDataContentSource

Um objeto EvalResponsesSource que descreve uma configuração de fonte de dados de execução.

Nome	Tipo	Descrição	Obrigatório
created_after	inteiro	Inclua somente itens criados após esse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas.	Não
criado_antes	inteiro	Inclua somente itens criados antes desse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas.	Não
instructions_search	cadeia	Cadeia de caracteres opcional para pesquisar o campo “instruções”. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
modelo	cadeia	O nome do modelo para o qual se quer encontrar respostas. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
esforço de raciocínio	objeto	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
temperatura	número	Temperatura de amostragem. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
Ferramentas	matriz	Lista de nomes de ferramentas. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
top_p	número	Parâmetro de amostragem de núcleo. Esse é um parâmetro de consulta usado para selecionar respostas.	Não
tipo	enumeração	O tipo de fonte de dados de execução. Sempre `responses`. Valores possíveis: `responses`	Yes
users	matriz	Lista de identificadores de usuário. Esse é um parâmetro de consulta usado para selecionar respostas.	Não

OpenAI.EvalRunStoredCompletionsDataContentSource

Uma configuração StoredCompletionsRunDataSource que descreve um conjunto de filtros

Nome	Tipo	Descrição	Obrigatório
created_after	inteiro	Um carimbo de data/hora Unix opcional para filtrar os itens criados após esse horário.	Não
criado_antes	inteiro	Um carimbo de data/hora Unix opcional para filtrar itens criados antes desse horário.	Não
limite	inteiro	Um número máximo opcional de itens a serem retornados.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
modelo	cadeia	Um modelo opcional para filtrar (por exemplo, 'gpt-4o').	Não
tipo	enumeração	O tipo de origem. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Preterido em favor de LogsDataSourceConfig.

Nome	Tipo	Descrição	Obrigatório	Padrão
metadados	objeto	Filtros de metadados da fonte de dados de conclusões armazenadas.	Não
tipo	enumeração	O tipo de fonte de dados. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Preterido em favor de LogsDataSourceConfig.

Nome	Tipo	Descrição	Obrigatório
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
esquema	objeto	O esquema JSON para os itens da fonte de dados de execução. Saiba como criar esquemas JSON aqui.	Yes
tipo	enumeração	O tipo de fonte de dados. Sempre `stored_completions`. Valores possíveis: `stored_completions`	Yes

OpenAI.FileSearchTool

Uma ferramenta que pesquisa conteúdo relevante de arquivos carregados.

Nome	Tipo	Descrição	Obrigatório
filters	objeto		Não
numero_maximo_de_resultados	inteiro	O número máximo de resultados a serem retornados. Esse número deve estar entre 1 e 50 inclusivo.	Não
opções_de_classificação	objeto		Não
└─ ranker	enumeração	O classificador a ser usado para a pesquisa de arquivos. Valores possíveis: `auto`, `default-2024-11-15`	Não
└─ limite_de_pontuação	número	O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	Não
tipo	enumeração	O tipo da ferramenta de pesquisa de arquivo. Sempre `file_search`. Valores possíveis: `file_search`	Yes
vector_store_ids	matriz	Os IDs dos repositórios de vetores a serem pesquisados.	Yes

OpenAI.FileSearchToolCallItemParam

Os resultados de uma chamada de ferramenta de pesquisa de arquivo.

Nome	Tipo	Descrição	Obrigatório
queries	matriz	As consultas usadas para pesquisar arquivos.	Yes
Resultados	matriz	Os resultados da chamada da ferramenta de pesquisa de arquivos.	Não
tipo	enumeração	Valores possíveis: `file_search_call`	Yes

OpenAI.FileSearchToolCallItemResource

Os resultados de uma chamada de ferramenta de pesquisa de arquivo.

Nome	Tipo	Descrição	Obrigatório
queries	matriz	As consultas usadas para pesquisar arquivos.	Yes
Resultados	matriz	Os resultados da chamada da ferramenta de pesquisa de arquivos.	Não
status	enumeração	O status da chamada da ferramenta de pesquisa de arquivos. Uma opção entre `in_progress`, `searching`, `incomplete` ou `failed`, Valores possíveis: `in_progress`, , `searching`, `completed`, `incomplete`, `failed`	Yes
tipo	enumeração	Valores possíveis: `file_search_call`	Yes

OpenAI.Filters

Nome	Tipo	Descrição	Obrigatório
filters	matriz	Matriz de filtros a serem combinados. Os itens podem ser `ComparisonFilter` ou `CompoundFilter`.	Yes
chave	cadeia	A chave a ser comparada com o valor.	Yes
tipo	enumeração	Tipo de operação: `and` ou `or`. Valores possíveis: `and`, `or`	Yes
value	cadeia de caracteres ou número ou booleano	O valor a ser comparado com a chave de atributo; dá suporte a tipos de cadeia de caracteres, número ou booliano.	Yes

OpenAI.FineTuneDPOHyperparameters

Os hiperparâmetros usados no trabalho de ajuste fino do DPO.

Nome	Tipo	Descrição	Obrigatório
tamanho_do_lote	enumeração	Valores possíveis: `auto`	Não
beta	enumeração	Valores possíveis: `auto`	Não
multiplicador_da_taxa_de_aprendizado	enumeração	Valores possíveis: `auto`	Não
n_épocas	enumeração	Valores possíveis: `auto`	Não

OpenAI.FineTuneDPOMethod

Configuração do método de ajuste fino do DPO.

Nome	Tipo	Descrição	Obrigatório	Padrão
hiperparâmetros	OpenAI.FineTuneDPOHyperparameters	Os hiperparâmetros usados no trabalho de ajuste fino do DPO.	Não

OpenAI.FineTuneMethod

O método usado no ajuste fino.

Nome	Tipo	Descrição	Obrigatório
dpo	OpenAI.FineTuneDPOMethod	Configuração do método de ajuste fino do DPO.	Não
reforço	AzureFineTuneReinforcementMethod		Não
Supervisionado	OpenAI.FineTuneSupervisedMethod	Configuração do método de ajuste fino a ser supervisionado.	Não
tipo	enumeração	O tipo de método. É, `supervised`, `dpo`ou `reinforcement`. Valores possíveis: `supervised`, , `dporeinforcement`	Yes

OpenAI.FineTuneReinforcementHyperparameters

Os hiperparâmetros usados no trabalho de ajuste fino de reforço.

Nome	Tipo	Descrição	Obrigatório
tamanho_do_lote	enumeração	Valores possíveis: `auto`	Não
compute_multiplier	enumeração	Valores possíveis: `auto`	Não
eval_interval	enumeração	Valores possíveis: `auto`	Não
eval_samples	enumeração	Valores possíveis: `auto`	Não
multiplicador_da_taxa_de_aprendizado	enumeração	Valores possíveis: `auto`	Não
n_épocas	enumeração	Valores possíveis: `auto`	Não
esforço de raciocínio	enumeração	Nível de esforço de raciocínio. Valores possíveis: `default`, , `low`, `mediumhigh`	Não

OpenAI.FineTuneSupervisedHyperparameters

Os hiperparâmetros usados no trabalho de ajuste fino.

Nome	Tipo	Descrição	Obrigatório
tamanho_do_lote	enumeração	Valores possíveis: `auto`	Não
multiplicador_da_taxa_de_aprendizado	enumeração	Valores possíveis: `auto`	Não
n_épocas	enumeração	Valores possíveis: `auto`	Não

OpenAI.FineTuneSupervisedMethod

Configuração do método de ajuste fino a ser supervisionado.

Nome	Tipo	Descrição	Obrigatório	Padrão
hiperparâmetros	OpenAI.FineTuneSupervisedHyperparameters	Os hiperparâmetros usados no trabalho de ajuste fino.	Não

OpenAI.FineTuningIntegration

Discriminatório para OpenAI.FineTuningIntegration

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

Valor do tipo	Esquema
`wandb`	OpenAI.FineTuningIntegrationWandb

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	cadeia de caracteres (veja os modelos válidos abaixo)		Yes

OpenAI.FineTuningIntegrationWandb

Nome	Tipo	Descrição	Obrigatório
tipo	enumeração	O tipo da integração que está sendo habilitada para o trabalho de ajuste fino Valores possíveis: `wandb`	Yes
wandb	objeto	As configurações para sua integração com Pesos e Vieses. Esta carga útil especifica o projeto para o qual as métricas serão enviadas. Opcionalmente, você pode definir um nome de exibição explícito para sua execução, adicionar marcas à sua execução e definir uma entidade padrão (equipe, nome de usuário, etc.) a ser associada à sua execução.	Yes
└─ entidade	cadeia	A entidade a ser usada para a execução. Isso permite que você defina a equipe ou o nome de usuário do WandB que você quer associar à execução. Se não estiver definido, será usada a entidade padrão para a chave de API do WandB registrada.	Não
└─ nome	cadeia	Um nome de exibição a ser definido para a execução. Se não estiver definido, usaremos a ID do trabalho como o nome.	Não
└─ projeto	cadeia	O nome do projeto no qual a nova execução será criada.	Não
└─ etiquetas	matriz	Uma lista de marcas a serem anexadas à execução recém-criada. Essas marcas são passadas diretamente para o WandB. Alguns as marcas padrão são geradas pelo OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	Não

OpenAI.FineTuningJob

O objeto fine_tuning.job representa um trabalho de ajuste fino que foi criado pela API.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da criação da tarefa de ajuste fino.	Yes
erro	objeto	Quanto aos trabalhos de ajuste fino que tenham `failed`, isso conterá mais informações sobre a causa da falha.	Yes
└─ código	cadeia	Um código de erro legível pelo computador.	Não
Mensagem └─	cadeia	Uma mensagem de erro legível por humanos.	Não
└─ param	cadeia	O parâmetro que era inválido, geralmente `training_file` ou `validation_file`. Esse campo será nulo se a falha não tiver sido específica do parâmetro.	Não
estimativa de conclusão	inteiro	O carimbo de data/hora unix (em segundos) para quando o trabalho de ajuste fino é estimado para ser concluído. O valor será nulo se o trabalho de ajuste fino não estiver em execução.	Não
fine_tuned_model	cadeia	O nome do modelo ajustado que está sendo criado. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
finished_at	inteiro	O carimbo de data/hora Unix (em segundos) de quando o trabalho de ajuste fino foi concluído. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
hiperparâmetros	objeto	Os hiperparâmetros usados no trabalho de ajuste fino. Esse valor só será retornado ao executar os trabalhos `supervised`.	Yes
└─ tamanho_do_lote (batch_size)	enumeração	Valores possíveis: `auto`	Não
└─ multiplicador_da_taxa_de_aprendizagem	enumeração	Valores possíveis: `auto`	Não
└─ n_epochs	enumeração	Valores possíveis: `auto`	Não
id	cadeia	O identificador do objeto, que pode ser referenciado nos pontos de extremidade da API.	Yes
Integrações	matriz	Uma lista de integrações para habilitar esse trabalho de ajuste fino.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
método	OpenAI.FineTuneMethod	O método usado no ajuste fino.	Não
modelo	cadeia	O modelo base que está sendo ajustado.	Yes
objeto	enumeração	O tipo de objeto, o qual será sempre "fine_tuning.job". Valores possíveis: `fine_tuning.job`	Yes
organization_id	cadeia	A organização que possui o trabalho de ajuste fino.	Yes
arquivos_de_resultado	matriz	As IDs do arquivo de resultados compilados para o trabalho de ajuste fino. Você pode recuperar os resultados com a API de Arquivos.	Yes
semente	inteiro	A posição inicial usada para o trabalho de ajuste fino.	Yes
status	enumeração	O status atual do trabalho de ajuste fino, que pode ser `validating_files`, `queued`, `running`, `succeeded`, `failed` ou `cancelled`. Valores possíveis: `validating_files`, , `queued`, `running`, `succeeded`, , `failedcancelled`	Yes
trained_tokens	inteiro	O número total de tokens faturáveis processados por esse trabalho de ajuste fino. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução.	Yes
arquivo_de_treinamento	cadeia	A ID do arquivo usada para treinamento. Você pode recuperar os dados de treinamento com a API de Arquivos.	Yes
user_provided_suffix	cadeia	O sufixo descritivo aplicado ao trabalho, conforme especificado na solicitação de criação do trabalho.	Não
arquivo_de_validação	cadeia	A ID do arquivo usada para validação. Você pode recuperar os resultados de validação com a API de Arquivos.	Yes

OpenAI.FineTuningJobCheckpoint

O objeto fine_tuning.job.checkpoint representa um ponto de verificação de modelo para um trabalho de ajuste fino que está pronto para ser usado.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	O carimbo de data/hora unix (em segundos) para quando o ponto de verificação foi criado.	Yes
fine_tuned_model_checkpoint	cadeia	O nome do modelo de ponto de verificação ajustado que é criado.	Yes
fine_tuning_job_id	cadeia	O nome do trabalho de ajuste fino do qual esse ponto de verificação foi criado.	Yes
id	cadeia	O identificador de ponto de verificação, que pode ser referenciado nos pontos de extremidade da API.	Yes
métricas	objeto	Métricas no número da etapa durante o trabalho de ajuste fino.	Yes
└─ full_valid_loss	número		Não
└─ full_valid_mean_token_accuracy	número		Não
└─ etapa	número		Não
└─ train_loss	número		Não
└─ train_mean_token_accuracy	número		Não
└─ perda_de_validação	número		Não
└─ precisão_média_dos_tokens_válidos	número		Não
objeto	enumeração	O tipo de objeto, o qual será sempre "fine_tuning.job.checkpoint". Valores possíveis: `fine_tuning.job.checkpoint`	Yes
número_do_passo	inteiro	O número da etapa em que o ponto de verificação foi criado.	Yes

OpenAI.FineTuningJobEvent

Ajustar objeto de evento de trabalho

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) da criação da tarefa de ajuste fino.	Yes
dados		Os dados associados ao evento.	Não
id	cadeia	O identificador do objeto.	Yes
nível	enumeração	O nível de log do evento. Valores possíveis: `info`, , `warnerror`	Yes
mensagem	cadeia	A mensagem do evento.	Yes
objeto	enumeração	O tipo de objeto, o qual será sempre "fine_tuning.job.event". Valores possíveis: `fine_tuning.job.event`	Yes
tipo	enumeração	O tipo do evento. Valores possíveis: `message`, `metrics`	Não

OpenAI.FunctionObject

Nome	Tipo	Descrição	Obrigatório	Padrão
descrição	cadeia	Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função.	Não
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
parâmetros		Os parâmetros aceitos pelas funções, descritos como um objeto de esquema JSON. Consulte o guia para obter exemplos e a Referência de esquema JSON para obter documentação sobre o formato. Omitir `parameters` define uma função com uma lista de parâmetros vazia.	Não
rigoroso	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a chamada de função. Se definido como true, o modelo seguirá o esquema exato definido no campo `parameters`. Somente um subconjunto de esquema JSON tem suporte quando `strict` é `true`. Saiba mais sobre saídas estruturadas no guia de chamada de função.	Não	Falso

OpenAI.FunctionTool

Define uma função em seu próprio código que o modelo pode optar por chamar. Saiba mais sobre chamada de função.

Nome	Tipo	Descrição	Obrigatório
descrição	cadeia	Uma descrição da função. Usado pelo modelo para determinar se a função deve ou não ser chamada.	Não
nome	cadeia	O nome da função a ser chamada.	Yes
parâmetros		Um objeto de esquema JSON que descreve os parâmetros da função.	Yes
rigoroso	boolean	Se deve impor a validação estrita de parâmetro. Padrão `true`.	Yes
tipo	enumeração	O tipo da ferramenta de função. Sempre `function`. Valores possíveis: `function`	Yes

OpenAI.FunctionToolCallItemParam

Uma chamada de ferramenta para executar uma função. Consulte o guia de chamada de função para obter mais informações.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
nome	cadeia	O nome da função a ser executada.	Yes
tipo	enumeração	Valores possíveis: `function_call`	Yes

OpenAI.FunctionToolCallItemResource

Uma chamada de ferramenta para executar uma função. Consulte o guia de chamada de função para obter mais informações.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos a serem passados para a função.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
nome	cadeia	O nome da função a ser executada.	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	Valores possíveis: `function_call`	Yes

OpenAI.FunctionToolCallOutputItemParam

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Descrição	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função.	Yes
tipo	enumeração	Valores possíveis: `function_call_output`	Yes

OpenAI.FunctionToolCallOutputItemResource

A saída de uma chamada de ferramenta de função.

Nome	Tipo	Descrição	Obrigatório
call_id	cadeia	A ID exclusiva da chamada da ferramenta de função gerada pelo modelo.	Yes
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função.	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	Valores possíveis: `function_call_output`	Yes

OpenAI.Grader

Discriminador do OpenAI.Grader

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

Valor do tipo	Esquema
`label_model`	OpenAI.GraderLabelModel
`text_similarity`	OpenAI.GraderTextSimilarity
`python`	OpenAI.GraderPython
`score_model`	OpenAI.GraderScoreModel
`multi`	OpenAI.GraderMulti

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.GraderType		Yes

OpenAI.GraderLabelModel

Um objeto LabelModelGrader que usa um modelo para atribuir rótulos a cada item na avaliação.

Nome	Tipo	Descrição	Obrigatório
entrada	matriz		Yes
rótulos	matriz	Os rótulos a serem atribuídos a cada item na avaliação.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas.	Yes
nome	cadeia	O nome do avaliador.	Yes
etiquetas_de_passagem	matriz	Os rótulos que indicam um resultado aprovado. Deve ser um subconjunto de rótulos.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `label_model`. Valores possíveis: `label_model`	Yes

OpenAI.GraderMulti

Um objeto MultiGrader combina os resultados de vários avaliadores para produzir uma única pontuação.

Nome	Tipo	Descrição	Obrigatório
calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Yes
Série	objeto		Yes
nome	cadeia	O nome do avaliador.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Yes

OpenAI.GraderPython

Um objeto PythonGrader que executa um script python na entrada.

Nome	Tipo	Descrição	Obrigatório
image_tag	cadeia	A marca da imagem a ser usada no script python.	Não
nome	cadeia	O nome do avaliador.	Yes
fonte	cadeia	O código-fonte do script python.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `python`. Valores possíveis: `python`	Yes

OpenAI.GraderScoreModel

Um objeto ScoreModelGrader que usa um modelo para atribuir uma pontuação à entrada.

Nome	Tipo	Descrição	Obrigatório
entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
modelo	cadeia	O modelo a ser usado para a avaliação.	Yes
nome	cadeia	O nome do avaliador.	Yes
alcance	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
sampling_params		Os parâmetros de amostragem do modelo.	Não
tipo	enumeração	O tipo de objeto, que é sempre `score_model`. Valores possíveis: `score_model`	Yes

OpenAI.GraderStringCheck

Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.

Nome	Tipo	Descrição	Obrigatório
entrada	cadeia	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Yes
nome	cadeia	O nome do avaliador.	Yes
operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Yes
referência	cadeia	O texto de referência. Isso pode incluir cadeias de caracteres de modelo.	Yes
tipo	enumeração	O tipo de objeto, que é sempre `string_check`. Valores possíveis: `string_check`	Yes

OpenAI.GraderTextSimilarity

Um objeto TextSimilarityGrader que classifica o texto com base em métricas de similaridade.

Nome	Tipo	Descrição	Obrigatório
métrica de avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Yes
entrada	cadeia	O texto que está sendo avaliado.	Yes
nome	cadeia	O nome do avaliador.	Yes
referência	cadeia	O texto de referência para avaliação.	Yes
tipo	enumeração	O tipo de avaliador. Valores possíveis: `text_similarity`	Yes

OpenAI.GraderType

Propriedade	Valor
Tipo	cadeia
Valores	`string_check` `text_similarity` `score_model` `label_model` `python` `multi`

OpenAI.ImageGenTool

Uma ferramenta que gera imagens usando um modelo como gpt-image-1-series.

Nome	Tipo	Descrição	Obrigatório	Padrão
em segundo plano	enumeração	Tipo de plano de fundo para a imagem gerada. Uma opção entre `transparent`, `opaque` ou `auto`. Padrão: `auto`. Valores possíveis: `transparent`, , `opaqueauto`	Não
input_image_mask	objeto	Máscara opcional para inpainting. Contém `image_url` (cadeia de caracteres, opcional) e `file_id` (cadeia de caracteres, opcional).	Não
└─ identificador_de_arquivo	cadeia	ID do arquivo para a imagem da máscara.	Não
└─ URL da imagem	cadeia	Imagem de máscara codificada em Base64.	Não
modelo	enumeração	O modelo de geração de imagem a ser usado. Padrão: `gpt-image-1`. Valores possíveis: `gpt-image-1`	Não
moderation	enumeração	Nível de moderação para a imagem gerada. Padrão: `auto`. Valores possíveis: `auto`, `low`	Não
compressão_de_saída	inteiro	Nível de compactação para a imagem de saída. Padrão: 100.	Não	100
formato de saída	enumeração	O formato de saída da imagem gerada. Um de `png`, `webp`, ou `jpeg`. Padrão: `png`. Valores possíveis: `png`, , `webpjpeg`	Não
imagens parciais	inteiro	Número de imagens parciais a serem geradas no modo de streaming, de 0 (valor padrão) a 3.	Não	0
quality	enumeração	A qualidade da imagem gerada. Uma opção entre `low`, `medium`, `high`, ou `auto`. Padrão: `auto`. Valores possíveis: `low`, , `medium`, `highauto`	Não
tamanho	enumeração	O tamanho da imagem gerada. Uma opção entre `1024x1024`, `1024x1536`, `1536x1024` ou `auto`. Padrão: `auto`. Valores possíveis: `1024x1024`, , `1024x1536`, `1536x1024auto`	Não
tipo	enumeração	O tipo da ferramenta de geração de imagem. Sempre `image_generation`. Valores possíveis: `image_generation`	Yes

OpenAI.ImageGenToolCallItemParam

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Descrição	Obrigatório	Padrão
result	cadeia	A imagem gerada codificada em base64.	Yes
tipo	enumeração	Valores possíveis: `image_generation_call`	Yes

OpenAI.ImageGenToolCallItemResource

Uma solicitação de geração de imagem feita pelo modelo.

Nome	Tipo	Descrição	Obrigatório
result	cadeia	A imagem gerada codificada em base64.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completed`, `generatingfailed`	Yes
tipo	enumeração	Valores possíveis: `image_generation_call`	Yes

OpenAI.ImplicitUserMessage

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	cadeia de caracteres ou matriz		Yes

OpenAI.Includable

Especifique dados de saída adicionais a serem incluídos na resposta do modelo. No momento, os valores com suporte são:

code_interpreter_call.outputs: inclui os resultados da execução do código python nos itens de chamada da ferramenta interpretadora de código.
computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
message.output_text.logprobs: inclua logprobs com mensagens de assistente.
reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas com várias rodadas ao usar a API de Respostas sem estado (como quando o parâmetro store é definido como false, ou quando uma organização é registrada no programa de retenção de dados zero).

Propriedade	Valor
Descrição	Especifique dados de saída adicionais a serem incluídos na resposta do modelo. No momento, os valores com suporte são: - `code_interpreter_call.outputs`: inclui as saídas da execução de código python nos itens de chamada de ferramenta de interpretador de código. - `computer_call_output.output.image_url`: incluir urls de imagem da saída da chamada de computador. - `file_search_call.results`: incluir os resultados da pesquisa de a chamada da ferramenta de pesquisa de arquivos. - `message.input_image.image_url`: incluir urls de imagem da mensagem de entrada. - `message.output_text.logprobs`: inclua os logprobs com mensagens de assistente. - `reasoning.encrypted_content`: inclui uma versão criptografada do raciocínio tokens em saídas de item de raciocínio. Isso permite que itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o parâmetro `store` é definido como `false`, ou quando uma organização é registrada no programa de retenção de dados zero).
Tipo	cadeia
Valores	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content`

OpenAI.ItemContent

Discriminador para OpenAI.ItemContent

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

Valor do tipo	Esquema
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ItemContentType	Conteúdo de entrada e saída multi modal.	Yes

OpenAI.ItemContentInputAudio

Uma entrada de áudio para o modelo.

Nome	Tipo	Descrição	Obrigatório
dados	cadeia	Dados de áudio codificados em Base64.	Yes
format	enumeração	O formato dos dados de áudio. Os formatos com suporte no momento são `mp3` e `wav`. Valores possíveis: `mp3`, `wav`	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_audio`. Valores possíveis: `input_audio`	Yes

OpenAI.ItemContentInputFile

Uma entrada de arquivo para o modelo.

Nome	Tipo	Descrição	Obrigatório
file_data	cadeia	O conteúdo do arquivo a ser enviado para o modelo.	Não
file_id	cadeia	A ID do arquivo a ser enviado para o modelo.	Não
nome do arquivo	cadeia	O nome do arquivo a ser enviado para o modelo.	Não
tipo	enumeração	O tipo do item de entrada. Sempre `input_file`. Valores possíveis: `input_file`	Yes

OpenAI.ItemContentInputImage

Uma entrada de imagem para o modelo.

Nome	Tipo	Descrição	Obrigatório
detail	enumeração	O nível de detalhes da imagem a ser enviada para o modelo. Uma opção entre `high`, `low` ou `auto`. Usa `auto` como padrão. Valores possíveis: `low`, , `highauto`	Não
file_id	cadeia	A ID do arquivo a ser enviado para o modelo.	Não
image_url	cadeia	A URL da imagem a ser enviada para o modelo. Uma URL totalmente qualificada ou uma imagem codificada em base64 em uma URL de dados.	Não
tipo	enumeração	O tipo do item de entrada. Sempre `input_image`. Valores possíveis: `input_image`	Yes

OpenAI.ItemContentInputText

Uma entrada de texto para o modelo.

Nome	Tipo	Descrição	Obrigatório	Padrão
enviar SMS	cadeia	A entrada de texto para o modelo.	Yes
tipo	enumeração	O tipo do item de entrada. Sempre `input_text`. Valores possíveis: `input_text`	Yes

OpenAI.ItemContentOutputAudio

Uma saída de áudio do modelo.

Nome	Tipo	Descrição	Obrigatório
dados	cadeia	Dados de áudio codificados em Base64 do modelo.	Yes
transcrição	cadeia	A transcrição dos dados de áudio do modelo.	Yes
tipo	enumeração	O tipo do áudio de saída. Sempre `output_audio`. Valores possíveis: `output_audio`	Yes

OpenAI.ItemContentOutputText

Uma saída de texto do modelo.

Nome	Tipo	Descrição	Obrigatório
Anotações	matriz	As anotações da saída de texto.	Yes
logprobs	matriz		Não
enviar SMS	cadeia	A saída de texto do modelo.	Yes
tipo	enumeração	O tipo do texto de saída. Sempre `output_text`. Valores possíveis: `output_text`	Yes

OpenAI.ItemContentRefusal

Uma recusa do modelo.

Nome	Tipo	Descrição	Obrigatório	Padrão
recusa	cadeia	A explicação da recusa do modelo.	Yes
tipo	enumeração	O tipo da recusa. Sempre `refusal`. Valores possíveis: `refusal`	Yes

OpenAI.ItemContentType

Conteúdo de entrada e saída multi modal.

Propriedade	Valor
Descrição	Conteúdo de entrada e saída multi modal.
Tipo	cadeia
Valores	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.ItemParam

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

Valor do tipo	Esquema
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`local_shell_call`	OpenAI.LocalShellToolCallItemParam
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam
`message`	OpenAI.ResponsesMessageItemParam

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ItemType		Yes

OpenAI.ItemReferenceItemParam

Um identificador interno para um item a ser referenciado.

Nome	Tipo	Descrição	Obrigatório	Padrão
id	cadeia	A ID originada pelo serviço do item de resposta gerado anteriormente sendo referenciado.	Yes
tipo	enumeração	Valores possíveis: `item_reference`	Yes

OpenAI.ItemResource

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.ItemResource

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

Valor do tipo	Esquema
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`local_shell_call`	OpenAI.LocalShellToolCallItemResource
`local_shell_call_output`	OpenAI.LocalShellToolCallOutputItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`mcp_call`	OpenAI.MCPCallItemResource
`message`	OpenAI.ResponsesMessageItemResource

Nome	Tipo	Descrição	Obrigatório	Padrão
id	cadeia		Yes
tipo	OpenAI.ItemType		Yes

OpenAI.ItemType

Propriedade	Valor
Tipo	cadeia
Valores	`message` `file_search_call` `function_call` `function_call_output` `computer_call` `computer_call_output` `web_search_call` `reasoning` `item_reference` `image_generation_call` `code_interpreter_call` `local_shell_call` `local_shell_call_output` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.ListFineTuningJobCheckpointsResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz		Yes
first_id	cadeia		Não
has_more	boolean		Yes
last_id	cadeia		Não
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz		Yes
has_more	boolean		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListModelsResponse

Nome	Tipo	Descrição	Obrigatório	Padrão
dados	matriz		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz		Yes
has_more	boolean		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListVectorStoreFilesFilter

Propriedade	Valor
Tipo	cadeia
Valores	`in_progress` `completed` `failed` `cancelled`

OpenAI.ListVectorStoreFilesResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz		Yes
first_id	cadeia		Yes
has_more	boolean		Yes
last_id	cadeia		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.ListVectorStoresResponse

Nome	Tipo	Descrição	Obrigatório
dados	matriz		Yes
first_id	cadeia		Yes
has_more	boolean		Yes
last_id	cadeia		Yes
objeto	enumeração	Valores possíveis: `list`	Yes

OpenAI.LocalShellExecAction

Execute um comando shell no servidor.

Nome	Tipo	Descrição	Obrigatório
comando	matriz	O comando a ser executado.	Yes
env	objeto	Variáveis de ambiente a serem definidas para o comando.	Yes
timeout_ms	inteiro	Tempo limite opcional em milissegundos para o comando.	Não
tipo	enumeração	O tipo da ação do shell local. Sempre `exec`. Valores possíveis: `exec`	Yes
usuário	cadeia	Usuário opcional para executar o comando como.	Não
working_directory	cadeia	Diretório de trabalho opcional para executar o comando.	Não

OpenAI.LocalShellTool

Uma ferramenta que permite que o modelo execute comandos de shell em um ambiente local.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo da ferramenta de shell local. Sempre `local_shell`. Valores possíveis: `local_shell`	Yes

OpenAI.LocalShellToolCallItemParam

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Descrição	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
tipo	enumeração	Valores possíveis: `local_shell_call`	Yes

OpenAI.LocalShellToolCallItemResource

Uma chamada de ferramenta para executar um comando no shell local.

Nome	Tipo	Descrição	Obrigatório
ação	OpenAI.LocalShellExecAction	Execute um comando shell no servidor.	Yes
call_id	cadeia	A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	Valores possíveis: `local_shell_call`	Yes

OpenAI.LocalShellToolCallOutputItemParam

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	Descrição	Obrigatório	Padrão
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
tipo	enumeração	Valores possíveis: `local_shell_call_output`	Yes

OpenAI.LocalShellToolCallOutputItemResource

A saída de uma chamada de ferramenta de shell local.

Nome	Tipo	Descrição	Obrigatório
saída	cadeia	Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local.	Yes
status	enumeração	Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	Valores possíveis: `local_shell_call_output`	Yes

OpenAI.Location

Discriminador para OpenAI.Location

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

Valor do tipo	Esquema
`approximate`	OpenAI.ApproximateLocation

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.LocationType		Yes

OpenAI.LocationType

Propriedade	Valor
Tipo	cadeia
Valores	`approximate`

OpenAI.LogProb

A probabilidade de log de um token.

Nome	Tipo	Obrigatório
bytes	matriz	Yes
logprob	número	Yes
símbolo	cadeia	Yes
top_logprobs	matriz	Yes

OpenAI.MCPApprovalRequestItemParam

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON de argumentos para a ferramenta.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	Valores possíveis: `mcp_approval_request`	Yes

OpenAI.MCPApprovalRequestItemResource

Uma solicitação de aprovação humana de uma invocação de ferramenta.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON de argumentos para a ferramenta.	Yes
nome	cadeia	O nome da ferramenta a ser executada.	Yes
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que está fazendo a solicitação.	Yes
tipo	enumeração	Valores possíveis: `mcp_approval_request`	Yes

OpenAI.MCPApprovalResponseItemParam

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	Descrição	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
reason	cadeia	Motivo opcional para a decisão.	Não
tipo	enumeração	Valores possíveis: `mcp_approval_response`	Yes

OpenAI.MCPApprovalResponseItemResource

Uma resposta a uma solicitação de aprovação do MCP.

Nome	Tipo	Descrição	Obrigatório
approval_request_id	cadeia	A ID da solicitação de aprovação que está sendo respondida.	Yes
aprovar	boolean	Se a solicitação foi aprovada.	Yes
reason	cadeia	Motivo opcional para a decisão.	Não
tipo	enumeração	Valores possíveis: `mcp_approval_response`	Yes

OpenAI.MCPCallItemParam

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia	O erro da chamada da ferramenta, se houver.	Não
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia	A saída da chamada da ferramenta.	Não
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
tipo	enumeração	Valores possíveis: `mcp_call`	Yes

OpenAI.MCPCallItemResource

Uma invocação de uma ferramenta em um servidor MCP.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta.	Yes
erro	cadeia	O erro da chamada da ferramenta, se houver.	Não
nome	cadeia	O nome da ferramenta que foi executada.	Yes
saída	cadeia	A saída da chamada da ferramenta.	Não
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP que executa a ferramenta.	Yes
tipo	enumeração	Valores possíveis: `mcp_call`	Yes

OpenAI.MCPListToolsItemParam

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Descrição	Obrigatório
erro	cadeia	Mensagem de erro se o servidor não puder listar ferramentas.	Não
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
Ferramentas	matriz	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	Valores possíveis: `mcp_list_tools`	Yes

OpenAI.MCPListToolsItemResource

Uma lista de ferramentas disponíveis em um servidor MCP.

Nome	Tipo	Descrição	Obrigatório
erro	cadeia	Mensagem de erro se o servidor não puder listar ferramentas.	Não
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP.	Yes
Ferramentas	matriz	As ferramentas disponíveis no servidor.	Yes
tipo	enumeração	Valores possíveis: `mcp_list_tools`	Yes

OpenAI.MCPListToolsTool

Uma ferramenta disponível em um servidor MCP.

Nome	Tipo	Descrição	Obrigatório
Anotações		Anotações adicionais sobre a ferramenta.	Não
descrição	cadeia	A descrição da ferramenta.	Não
input_schema		O esquema JSON que descreve a entrada da ferramenta.	Yes
nome	cadeia	O nome da ferramenta.	Yes

OpenAI.MCPTool

Conceda ao modelo acesso a ferramentas adicionais por meio de servidores remotos do Protocolo de Contexto de Modelo.

Nome	Tipo	Descrição	Obrigatório
ferramentas_permitidas	objeto		Não
└─ nomes_das_ferramentas	matriz	Lista de nomes de ferramentas permitidos.	Não
headers	objeto	Cabeçalhos HTTP opcionais para enviar ao servidor MCP. Usar para autenticação ou outras finalidades.	Não
requer_aprovação	objeto (consulte modelos válidos abaixo)	Especifique quais das ferramentas do servidor MCP exigem aprovação.	Não
etiqueta_do_servidor	cadeia	Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta.	Yes
URL_do_servidor	cadeia	A URL do servidor MCP.	Yes
tipo	enumeração	O tipo da ferramenta MCP. Sempre `mcp`. Valores possíveis: `mcp`	Yes

OpenAI.MetadataPropertyForRequest

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.

Nome	Tipo	Descrição	Obrigatório	Padrão
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não

OpenAI.Model

Descreve uma oferta do modelo OpenAI que pode ser usada com a API.

Nome	Tipo	Descrição	Obrigatório
criado	inteiro	O carimbo de data/hora unix (em segundos) quando o modelo foi criado.	Yes
id	cadeia	O identificador de modelo, que pode ser referenciado nos pontos de extremidade da API.	Yes
objeto	enumeração	O tipo de objeto, que é sempre "modelo". Valores possíveis: `model`	Yes
owned_by	cadeia	A organização que possui o modelo.	Yes

OpenAI.OtherChunkingStrategyResponseParam

Isso é retornado quando a estratégia de divisão em partes é desconhecida. Normalmente, isso ocorre porque o arquivo foi indexado antes do conceito de chunking_strategy ser introduzido na API.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Sempre `other`. Valores possíveis: `other`	Yes

OpenAI.ParallelToolCalls

Se deseja habilitar a chamada de função paralela durante o uso da ferramenta.

Tipo: booliano

OpenAI.Prompt

Referência a um modelo de prompt e suas variáveis.

Nome	Tipo	Descrição	Obrigatório
id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Yes
variables	objeto	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
versão	cadeia	Versão opcional do modelo de prompt.	Não

OpenAI.RankingOptions

Nome	Tipo	Descrição	Obrigatório	Padrão
classificador	enumeração	O classificador a ser usado para a pesquisa de arquivos. Valores possíveis: `auto`, `default-2024-11-15`	Não
limiar_de_pontuação	número	O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados.	Não

OpenAI.Reasoning

somente modelos de raciocínio

Opções de configuração para modelos de raciocínio.

Nome	Tipo	Descrição	Obrigatório
Esforço	objeto	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
generate_summary	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não

OpenAI.ReasoningEffort

somente modelos de raciocínio

Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são low, medium e high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio de uma resposta.

Propriedade	Valor
Descrição	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.
Tipo	cadeia
Valores	`low` `medium` `high`

OpenAI.ReasoningItemParam

Uma descrição da cadeia de pensamento usada por um modelo de raciocínio ao gerar uma resposta. Certifique-se de incluir esses itens em inputpara a API de Respostas para as próximas rodadas de uma conversa se você estiver gerenciando manualmente o contexto.

Nome	Tipo	Descrição	Obrigatório
encrypted_content	cadeia	O conteúdo criptografado do item de raciocínio — preenchido quando uma resposta for gerado com `reasoning.encrypted_content` no parâmetro `include`.	Não
resumo	matriz	Conteúdo de texto de raciocínio.	Yes
tipo	enumeração	Valores possíveis: `reasoning`	Yes

OpenAI.ReasoningItemResource

Nome	Tipo	Descrição	Obrigatório
encrypted_content	cadeia	O conteúdo criptografado do item de raciocínio — preenchido quando uma resposta for gerado com `reasoning.encrypted_content` no parâmetro `include`.	Não
resumo	matriz	Conteúdo de texto de raciocínio.	Yes
tipo	enumeração	Valores possíveis: `reasoning`	Yes

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Valor do tipo	Esquema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ReasoningItemSummaryPartType		Yes

OpenAI.ReasoningItemSummaryPartType

Propriedade	Valor
Tipo	cadeia
Valores	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Nome	Tipo	Descrição	Obrigatório	Padrão
enviar SMS	cadeia		Yes
tipo	enumeração	Valores possíveis: `summary_text`	Yes

OpenAI.Response

Nome	Tipo	Descrição	Obrigatório	Padrão
em segundo plano	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
criado_em	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Yes
erro	objeto	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Yes
└─ código	OpenAI.ResponseErrorCode	O código de erro da resposta.	Não
Mensagem └─	cadeia	Uma descrição do erro legível para humanos.	Não
id	cadeia	Identificador exclusivo para esta Resposta.	Yes
incomplete_details	objeto	Detalhes sobre por que a resposta está incompleta.	Yes
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
instructions	cadeia de caracteres ou matriz		Yes
max_output_tokens	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Yes
saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Yes
output_text	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Yes	Verdade
previous_response_id	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
solicitação	objeto	Referência a um modelo de prompt e suas variáveis.	Não
└─ id	cadeia	O identificador exclusivo do modelo de prompt a ser usado.	Não
└─ variáveis	OpenAI.ResponsePromptVariables	Mapa opcional de valores a serem substituídos por variáveis no seu solicitação. Os valores de substituição podem ser cadeias de caracteres ou outros Tipos de entrada de resposta, como imagens ou arquivos.	Não
└─ versão	cadeia	Versão opcional do modelo de prompt.	Não
reasoning	objeto	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ esforço	Esforço de Raciocínio da OpenAI	somente modelos de raciocínio Restringe o esforço de raciocínio para modelos de raciocínio. Os valores atualmente com suporte são `low`, `medium` e `high`. 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.	Não
└─ gerar_resumo	enumeração	Preterido: use `summary` em vez disso. Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
└─ resumo	enumeração	Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depuração e reconhecimento do processo de raciocínio do modelo. Uma opção entre `auto`, `concise` ou `detailed`. Valores possíveis: `auto`, , `concisedetailed`	Não
status	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Yes
enviar SMS	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
tool_choice	objeto	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.	Não
└─ tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.	Não
Ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
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 de log associada.	Não
top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Yes
truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitido quando um snippet de código parcial é transmitido pelo interpretador de código.

Nome	Tipo	Descrição	Obrigatório
delta	cadeia	O snippet de código parcial que está sendo transmitido pelo interpretador de código.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída na resposta para o qual o código está sendo transmitido.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call_code.delta`. Valores possíveis: `response.code_interpreter_call_code.delta`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Emitido quando o snippet de código é finalizado pelo interpretador de código.

Nome	Tipo	Descrição	Obrigatório
codificar	cadeia	A saída final do snippet de código pelo intérprete de código.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	inteiro	O índice do item de saída na resposta para a qual o código é finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call_code.done`. Valores possíveis: `response.code_interpreter_call_code.done`	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Emitido quando a chamada do interpretador de código é concluída.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código é concluída.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.completed`. Valores possíveis: `response.code_interpreter_call.completed`	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitido quando uma chamada de intérprete de código está em andamento.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	inteiro	O índice do item de saída na resposta para a qual a chamada do interpretador de código está em andamento.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.in_progress`. Valores possíveis: `response.code_interpreter_call.in_progress`	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitido quando o intérprete de código estiver interpretando ativamente o snippet de código.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta interpretadora de código.	Yes
output_index	inteiro	O índice do item de saída na resposta para a qual o interpretador de código está interpretando o código.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.code_interpreter_call.interpreting`. Valores possíveis: `response.code_interpreter_call.interpreting`	Yes

OpenAI.ResponseCompletedEvent

Emitido quando a resposta do modelo é concluída.

Nome	Tipo	Descrição	Obrigatório	Padrão
response	objeto		Yes
└─ tela de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
└─ created_at	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta Resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
└─ parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o parâmetro `tools` para ver como especificar quais ferramentas o modelo pode chamar.	Não
└─ ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
└─ 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 de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não
tipo	enumeração	O tipo de evento. Sempre `response.completed`. Valores possíveis: `response.completed`	Yes

OpenAI.ResponseContentPartAddedEvent

Emitido quando uma nova parte de conteúdo é adicionada.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que foi adicionada.	Yes
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ItemContentType	Conteúdo de entrada e saída multi modal.	Não
tipo	enumeração	O tipo de evento. Sempre `response.content_part.added`. Valores possíveis: `response.content_part.added`	Yes

OpenAI.ResponseContentPartDoneEvent

Emitido quando uma parte do conteúdo é concluída.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que é concluída.	Yes
item_id	cadeia	A ID do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
output_index	inteiro	O índice do item de saída ao qual a parte de conteúdo foi adicionada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ItemContentType	Conteúdo de entrada e saída multi modal.	Não
tipo	enumeração	O tipo de evento. Sempre `response.content_part.done`. Valores possíveis: `response.content_part.done`	Yes

OpenAI.ResponseCreatedEvent

Um evento emitido quando uma resposta é criada.

Nome	Tipo	Descrição	Obrigatório	Padrão
response	objeto		Yes
└─ tela de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
└─ created_at	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta Resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
└─ parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o parâmetro `tools` para ver como especificar quais ferramentas o modelo pode chamar.	Não
└─ ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
└─ 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 de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não
tipo	enumeração	O tipo de evento. Sempre `response.created`. Valores possíveis: `response.created`	Yes

OpenAI.ResponseError

Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.

Nome	Tipo	Descrição	Obrigatório	Padrão
codificar	OpenAI.ResponseErrorCode	O código de erro da resposta.	Yes
mensagem	cadeia	Uma descrição do erro legível para humanos.	Yes

OpenAI.ResponseErrorCode

O código de erro da resposta.

Propriedade	Valor
Descrição	O código de erro da resposta.
Tipo	cadeia
Valores	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Emitido quando ocorre um erro.

Nome	Tipo	Descrição	Obrigatório
codificar	cadeia	O código do erro.	Yes
mensagem	cadeia	A mensagem de erro.	Yes
param	cadeia	O parâmetro de erro.	Yes
tipo	enumeração	O tipo de evento. Sempre `error`. Valores possíveis: `error`	Yes

OpenAI.ResponseFailedEvent

Um evento emitido quando uma resposta falha.

Nome	Tipo	Descrição	Obrigatório	Padrão
response	objeto		Yes
└─ tela de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
└─ created_at	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta Resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
└─ parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o parâmetro `tools` para ver como especificar quais ferramentas o modelo pode chamar.	Não
└─ ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
└─ 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 de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não
tipo	enumeração	O tipo de evento. Sempre `response.failed`. Valores possíveis: `response.failed`	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

Emitido quando uma chamada de pesquisa de arquivo é concluída (resultados encontrados).

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.completed`. Valores possíveis: `response.file_search_call.completed`	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Emitido quando uma chamada de pesquisa de arquivo é iniciada.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.in_progress`. Valores possíveis: `response.file_search_call.in_progress`	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Emitido quando uma pesquisa de arquivo está em andamento.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	A ID do item de saída que a chamada de pesquisa de arquivo é iniciada.	Yes
output_index	inteiro	O índice do item de saída que a chamada de pesquisa de arquivo está pesquisando.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.file_search_call.searching`. Valores possíveis: `response.file_search_call.searching`	Yes

OpenAI.ResponseFormat

Discriminador para OpenAI.ResponseFormat

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

Valor do tipo	Esquema
`text`	OpenAI.ResponseFormatText
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `text`, , `json_objectjson_schema`	Yes

OpenAI.ResponseFormatJsonObject

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

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

OpenAI.ResponseFormatJsonSchema

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Nome	Tipo	Descrição	Obrigatório	Padrão
json_schema	objeto	Opções de configuração de Saídas Estruturadas, incluindo um esquema JSON.	Yes
└─ descrição	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	Não
└─ nome	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Não
└─ esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.	Não
└─ rigoroso	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo `schema`. Há suporte apenas para um subconjunto de esquema JSON quando `strict` é `true`. Para saber mais, leia o guia de Saídas Estruturadas .	Não	Falso
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_schema`. Valores possíveis: `json_schema`	Yes

OpenAI.ResponseFormatJsonSchemaSchema

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

Tipo: objeto

OpenAI.ResponseFormatText

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

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Emitido quando há um delta de argumentos parciais de chamada de função.

Nome	Tipo	Descrição	Obrigatório
delta	cadeia	O delta de argumentos de chamada de função que é adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída ao qual o delta de argumentos de chamada de função é adicionado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.function_call_arguments.delta`. Valores possíveis: `response.function_call_arguments.delta`	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Emitido quando os argumentos de chamada de função são finalizados.

Nome	Tipo	Descrição	Obrigatório
arguments	cadeia	Os argumentos de chamada de função.	Yes
item_id	cadeia	O ID do item.	Yes
output_index	inteiro	O índice do item de saída.	Yes
tipo	enumeração	Valores possíveis: `response.function_call_arguments.done`	Yes

OpenAI.ResponseImageGenCallCompletedEvent

Emitido quando uma chamada de ferramenta de geração de imagem é concluída e a imagem final está disponível.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.completed'. Valores possíveis: `response.image_generation_call.completed`	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

Emitido quando uma chamada de ferramenta de geração de imagem está gerando ativamente uma imagem (estado intermediário).

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Always 'response.image_generation_call.generating'. Valores possíveis: `response.image_generation_call.generating`	Yes

OpenAI.ResponseImageGenCallInProgressEvent

Emitido quando uma chamada de ferramenta de geração de imagem está em andamento.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Always 'response.image_generation_call.in_progress'. Valores possíveis: `response.image_generation_call.in_progress`	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Emitido quando uma imagem parcial está disponível durante o streaming de geração de imagem.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de geração de imagem que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
partial_image_b64	cadeia	Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem.	Yes
partial_image_index	inteiro	Índice baseado em 0 para a imagem parcial (o back-end é baseado em 1, mas é baseado em 0 para o usuário).	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.image_generation_call.partial_image'. Valores possíveis: `response.image_generation_call.partial_image`	Yes

OpenAI.ResponseInProgressEvent

Emitido quando a resposta está em andamento.

Nome	Tipo	Descrição	Obrigatório	Padrão
response	objeto		Yes
└─ tela de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
└─ created_at	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta Resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
└─ parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o parâmetro `tools` para ver como especificar quais ferramentas o modelo pode chamar.	Não
└─ ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
└─ 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 de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não
tipo	enumeração	O tipo de evento. Sempre `response.in_progress`. Valores possíveis: `response.in_progress`	Yes

OpenAI.ResponseIncompleteEvent

Um evento emitido quando uma resposta é concluída como incompleta.

Nome	Tipo	Descrição	Obrigatório	Padrão
response	objeto		Yes
└─ tela de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
└─ created_at	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta Resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
└─ parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o parâmetro `tools` para ver como especificar quais ferramentas o modelo pode chamar.	Não
└─ ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
└─ 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 de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não
tipo	enumeração	O tipo de evento. Sempre `response.incomplete`. Valores possíveis: `response.incomplete`	Yes

OpenAI.ResponseItemList

Uma lista de itens de resposta.

Nome	Tipo	Descrição	Obrigatório
dados	matriz	Uma lista de itens usados para gerar essa resposta.	Yes
first_id	cadeia	A ID do primeiro item da lista.	Yes
has_more	boolean	Se há mais itens disponíveis.	Yes
last_id	cadeia	A ID do último item da lista.	Yes
objeto	enumeração	O tipo de objeto retornado deve ser `list`. Valores possíveis: `list`	Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Emitido quando há um delta (atualização parcial) para os argumentos de uma chamada de ferramenta MCP.

Nome	Tipo	Descrição	Obrigatório
delta		A atualização parcial para os argumentos da chamada da ferramenta MCP.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.arguments_delta'. Valores possíveis: `response.mcp_call.arguments_delta`	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Emitido quando os argumentos de uma chamada de ferramenta MCP são finalizados.

Nome	Tipo	Descrição	Obrigatório
arguments		Os argumentos finalizados para a chamada da ferramenta MCP.	Yes
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.arguments_done'. Valores possíveis: `response.mcp_call.arguments_done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

Emitido quando uma chamada de ferramenta MCP é concluída com sucesso.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Always 'response.mcp_call.completed'. Valores possíveis: `response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falha.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_call.falhou'. Valores possíveis: `response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

Emitido quando uma chamada de ferramenta MCP está em andamento.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Always 'response.mcp_call.in_progress'. Valores possíveis: `response.mcp_call.in_progress`	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Emitido quando a lista de ferramentas MCP disponíveis foi recuperada com sucesso.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.completed'. Valores possíveis: `response.mcp_list_tools.completed`	Yes

OpenAI.ResponseMCPListToolsFailedEvent

Emitido quando a tentativa de listar as ferramentas MCP disponíveis falhou.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.falhou'. Valores possíveis: `response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Emitido quando o sistema está no processo de recuperação da lista de ferramentas MCP disponíveis.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de evento. Sempre 'response.mcp_list_tools.in_progress'. Valores possíveis: `response.mcp_list_tools.in_progress`	Yes

OpenAI.ResponseOutputItemAddedEvent

Emitido quando um novo item de saída é adicionado.

Nome	Tipo	Descrição	Obrigatório
item	objeto	Item de conteúdo usado para gerar uma resposta.	Yes
└─ id	cadeia		Não
└─ tipo	OpenAI.ItemType		Não
output_index	inteiro	O índice do item de saída que foi adicionado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_item.added`. Valores possíveis: `response.output_item.added`	Yes

OpenAI.ResponseOutputItemDoneEvent

Emitido quando um item de saída é marcado como concluído.

Nome	Tipo	Descrição	Obrigatório
item	objeto	Item de conteúdo usado para gerar uma resposta.	Yes
└─ id	cadeia		Não
└─ tipo	OpenAI.ItemType		Não
output_index	inteiro	O índice do item de saída que foi marcado como concluído.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_item.done`. Valores possíveis: `response.output_item.done`	Yes

OpenAI.ResponsePromptVariables

Mapa opcional de valores a serem substituídos por variáveis no seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

Emitido quando uma resposta é enfileirada e aguardando para ser processada.

Nome	Tipo	Descrição	Obrigatório	Padrão
response	objeto		Yes
└─ tela de fundo	boolean	Se a resposta do modelo deve ser executada em segundo plano. Saiba mais.	Não	Falso
└─ created_at	inteiro	Carimbo de data/hora UNIX (em segundos) de quando esta Resposta foi criada.	Não
└─ erro	OpenAI.ResponseError	Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.	Não
└─ id	cadeia	Identificador exclusivo para esta Resposta.	Não
└─ detalhes_incompletos	objeto	Detalhes sobre por que a resposta está incompleta.	Não
└─ motivo	enumeração	O motivo pelo qual a resposta está incompleta. Valores possíveis: `max_output_tokens`, `content_filter`	Não
└─ instruções	cadeia de caracteres ou matriz	Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo. Ao usar junto com `previous_response_id`, as instruções de uma resposta A resposta não será transferida para a próxima resposta. Isso simplifica para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.	Não
└─ max_output_tokens (número máximo de tokens de saída)	inteiro	Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio.	Não
└─ max_tool_calls	inteiro	O número máximo de chamadas totais das ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas.	Não
└─ metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
└─ objeto	enumeração	O tipo de objeto desse recurso – sempre definido como `response`. Valores possíveis: `response`	Não
└─ saída	matriz	Uma matriz de itens de conteúdo gerados pelo modelo. - O comprimento e a ordem dos itens na matriz `output` dependem na resposta do modelo. – Em vez de acessar o primeiro item na matriz `output` e supondo que seja uma mensagem `assistant` com o conteúdo gerado pelo o modelo, você pode considerar o uso da propriedade `output_text` em que com suporte em SDKs.	Não
└─ texto_de_saida	cadeia	Propriedade de conveniência exclusiva do SDK que contém a saída de texto agregada de todos os itens de `output_text` na matriz `output`, se houver algum presente. Com suporte nos SDKs Python e JavaScript.	Não
└─ parallel_tool_calls	boolean	Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo.	Não	Verdade
└─ ID_de_resposta_anterior	cadeia	A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos.	Não
└─ comando	OpenAI.Prompt	Referência a um modelo de prompt e suas variáveis.	Não
└─ raciocínio	OpenAI.Reasoning	somente modelos de raciocínio Opções de configuração para modelos de raciocínio.	Não
└─ estado	enumeração	O status da geração de resposta. Uma opção entre `completed`, `failed`, `in_progress`, `cancelled`, `queued`ou `incomplete`. Valores possíveis: `completed`, , `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	Não
└─ temperatura	número	Qual temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 a tornarão mais focada e determinística. Geralmente recomendamos alterar isso ou `top_p`, mas não as duas coisas.	Não
└─ texto	objeto	Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. Saiba mais: Saídas estruturadas	Não
└─ formato	OpenAI.ResponseTextFormatConfiguration		Não
└─ escolha_de_ferramenta	OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject	Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o parâmetro `tools` para ver como especificar quais ferramentas o modelo pode chamar.	Não
└─ ferramentas	matriz	Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o parâmetro `tool_choice`. As duas categorias de ferramentas que você pode fornecer ao modelo são: - Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem as funcionalidades do modelo, como pesquisa na Web ou pesquisa de arquivos.	Não
└─ 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 de log associada.	Não
└─ top_p	número	Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com probabilidade top_p mass. Portanto, 0,1 significa que apenas os tokens que compreendem a massa de probabilidade dos 10% superiores são considerados. Geralmente recomendamos alterar isso ou `temperature`, mas não as duas coisas.	Não
└─ truncamento	enumeração	A estratégia de truncamento a ser usada para a resposta do modelo. - `auto`: se o contexto dessa resposta e os anteriores exceder o tamanho da janela de contexto do modelo, o modelo truncará a resposta para ajustar a janela de contexto soltando itens de entrada no meio da conversa. - `disabled` (padrão): se uma resposta de modelo exceder a janela de contexto tamanho de um modelo, a solicitação falhará com um erro 400. Valores possíveis: `auto`, `disabled`	Não
└─ uso	OpenAI.ResponseUsage	Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento dos tokens de saída e o total de tokens usados.	Não
└─ usuário	cadeia	Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos.	Não
tipo	enumeração	O tipo de evento. Sempre 'response.enfileirado'. Valores possíveis: `response.queued`	Yes

OpenAI.ResponseReasoningDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo do raciocínio.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo de raciocínio dentro do item de saída.	Yes
delta		A atualização parcial para o conteúdo de raciocínio.	Yes
item_id	cadeia	O identificador exclusivo do item para o qual o raciocínio está sendo atualizado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.reasoning.delta'. Valores possíveis: `response.reasoning.delta`	Yes

OpenAI.ResponseReasoningDoneEvent

Emitido quando o conteúdo do raciocínio é finalizado para um item.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo de raciocínio dentro do item de saída.	Yes
item_id	cadeia	O identificador exclusivo do item para o qual o raciocínio é finalizado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
enviar SMS	cadeia	O texto de raciocínio finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre 'response.reasoning.done'. Valores possíveis: `response.reasoning.done`	Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo de resumo do raciocínio.

Nome	Tipo	Descrição	Obrigatório
delta		A atualização parcial para o conteúdo de resumo do raciocínio.	Yes
item_id	cadeia	O identificador exclusivo do item para o qual o resumo do raciocínio está sendo atualizado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do item de saída.	Yes
tipo	enumeração	O tipo de evento. Sempre "response.reasoning_summary.delta". Valores possíveis: `response.reasoning_summary.delta`	Yes

OpenAI.ResponseReasoningSummaryDoneEvent

Emitido quando o conteúdo do resumo do raciocínio é finalizado para um item.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	O identificador exclusivo do item para o qual o resumo do raciocínio é finalizado.	Yes
output_index	inteiro	O índice do item de saída na matriz de saída da resposta.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do item de saída.	Yes
enviar SMS	cadeia	O texto de resumo do raciocínio finalizado.	Yes
tipo	enumeração	O tipo de evento. Always 'response.reasoning_summary.done'. Valores possíveis: `response.reasoning_summary.done`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitido quando uma nova parte de resumo de raciocínio é adicionada.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Yes
output_index	inteiro	O índice do item de saída ao qual essa parte de resumo está associada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ReasoningItemSummaryPartType		Não
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.added`. Valores possíveis: `response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte de resumo de raciocínio é concluída.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	A ID do item à qual essa parte de resumo está associada.	Yes
output_index	inteiro	O índice do item de saída ao qual essa parte de resumo está associada.	Yes
part	objeto		Yes
└─ tipo	OpenAI.ReasoningItemSummaryPartType		Não
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_part.done`. Valores possíveis: `response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitido quando um delta é adicionado a um texto de resumo de raciocínio.

Nome	Tipo	Descrição	Obrigatório
delta	cadeia	O delta de texto que foi adicionado ao resumo.	Yes
item_id	cadeia	A ID do item ao qual este delta de texto de resumo está associado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída ao qual este delta de texto de resumo está associado.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.delta`. Valores possíveis: `response.reasoning_summary_text.delta`	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitido quando um texto de resumo de raciocínio é concluído.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	A ID do item ao qual este texto de resumo está associado.	Yes
output_index	inteiro	O índice do item de saída ao qual este texto de resumo está associado.	Yes
summary_index	inteiro	O índice da parte de resumo dentro do resumo do raciocínio.	Yes
enviar SMS	cadeia	O texto completo do resumo do raciocínio concluído.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.reasoning_summary_text.done`. Valores possíveis: `response.reasoning_summary_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

Emitido quando há um texto de recusa parcial.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo à qual o texto de recusa é adicionado.	Yes
delta	cadeia	O texto de recusa que é adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o texto de recusa é adicionado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída ao qual o texto de recusa é adicionado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.refusal.delta`. Valores possíveis: `response.refusal.delta`	Yes

OpenAI.ResponseRefusalDoneEvent

Emitido quando o texto de recusa é finalizado.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que o texto de recusa é finalizado.	Yes
item_id	cadeia	A ID do item de saída em que o texto de recusa é finalizado.	Yes
output_index	inteiro	O índice do item de saída em que o texto de recusa é finalizado.	Yes
recusa	cadeia	O texto de recusa finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.refusal.done`. Valores possíveis: `response.refusal.done`	Yes

OpenAI.ResponseStreamEvent

Discriminador para OpenAI.ResponseStreamEvent

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

Valor do tipo	Esquema
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.ResponseFailedEvent
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call_code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call_code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Nome	Tipo	Descrição	Obrigatório	Padrão
sequence_number	inteiro	O número sequencial para esse evento.	Yes
tipo	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Propriedade Valor

Tipo cadeia

Valores response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call_code.delta
response.code_interpreter_call_code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Emitido quando há um delta de texto adicional.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo à qual o delta de texto foi adicionado.	Yes
delta	cadeia	O delta de texto que foi adicionado.	Yes
item_id	cadeia	A ID do item de saída ao qual o delta de texto foi adicionado.	Yes
Ofuscação	cadeia	Um campo de caracteres aleatórios introduzido pela ofuscação do fluxo. A ofuscação de fluxo é um mecanismo que atenua determinados ataques de canal lateral.	Yes
output_index	inteiro	O índice do item de saída ao qual o delta de texto foi adicionado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_text.delta`. Valores possíveis: `response.output_text.delta`	Yes

OpenAI.ResponseTextDoneEvent

Emitido quando o conteúdo do texto é finalizado.

Nome	Tipo	Descrição	Obrigatório
content_index	inteiro	O índice da parte de conteúdo que o conteúdo do texto é finalizado.	Yes
item_id	cadeia	A ID do item de saída em que o conteúdo do texto é finalizado.	Yes
output_index	inteiro	O índice do item de saída que o conteúdo do texto é finalizado.	Yes
enviar SMS	cadeia	O conteúdo do texto finalizado.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.output_text.done`. Valores possíveis: `response.output_text.done`	Yes

OpenAI.ResponseTextFormatConfiguration

Discriminador para OpenAI.ResponseTextFormatConfiguration

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

Valor do tipo	Esquema
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ResponseTextFormatConfigurationType	Um objeto que especifica o formato que o modelo deve gerar. Configurar `{ "type": "json_schema" }` habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais em Guia de Saídas Estruturadas. O formato padrão é `{ "type": "text" }` sem opções adicionais. Não recomendado para modelos gpt-4o e mais recentes: Definir para `{ "type": "json_object" }` habilita o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo seja JSON válida. Usando o `json_schema` é preferencial para modelos que dão suporte a isso.	Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `json_object`	Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

Formato de resposta de esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Nome	Tipo	Descrição	Obrigatório	Padrão
descrição	cadeia	Uma descrição do formato de resposta, usado pelo modelo para determinar como responder no formato.	Não
nome	cadeia	O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64.	Yes
esquema	OpenAI.ResponseFormatJsonSchemaSchema	O esquema para o formato de resposta, descrito como um objeto de esquema JSON. Saiba como criar esquemas JSON aqui.	Yes
rigoroso	boolean	Se deseja habilitar a adesão estrita do esquema ao gerar a saída. Se definido como true, o modelo sempre seguirá o esquema exato definido no campo `schema`. Há suporte apenas para um subconjunto de esquema JSON quando `strict` é `true`. Para saber mais, leia o guia de Saídas Estruturadas .	Não	Falso
tipo	enumeração	O tipo de formato de resposta que está sendo definido. Sempre `json_schema`. Valores possíveis: `json_schema`	Yes

OpenAI.ResponseTextFormatConfigurationText

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `text`	Yes

OpenAI.ResponseTextFormatConfigurationType

Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia de Saídas Estruturadas.

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para modelos gpt-4o e mais recentes:

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.

Propriedade	Valor
Descrição	Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. Saiba mais no guia de Saídas Estruturadas.

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para modelos gpt-4o e mais recentes:

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, um detalhamento de tokens de saída e o total de tokens usados.

Nome	Tipo	Descrição	Obrigatório
input_tokens	inteiro	O número de tokens de entrada.	Yes
input_tokens_details	objeto	Um detalhamento dos tokens de entrada.	Yes
└─ tokens em cache	inteiro	O número de tokens recuperados do cache. Mais informações sobre o cache de prompts.	Não
output_tokens	inteiro	O número de tokens de saída.	Yes
output_tokens_details	objeto	Um detalhamento dos tokens de saída.	Yes
└─ tokens_de_raciocínio	inteiro	O número de tokens de raciocínio.	Não
total_tokens	inteiro	O número total de tokens usados.	Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.completed`. Valores possíveis: `response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.in_progress`. Valores possíveis: `response.web_search_call.in_progress`	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
item_id	cadeia	ID exclusiva para o item de saída associado à chamada de pesquisa na Web.	Yes
output_index	inteiro	O índice do item de saída ao qual a chamada de pesquisa na Web está associada.	Yes
tipo	enumeração	O tipo de evento. Sempre `response.web_search_call.searching`. Valores possíveis: `response.web_search_call.searching`	Yes

OpenAI.ResponsesAssistantMessageItemParam

Um item de parâmetro de mensagem com a função assistant.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `assistant`. Valores possíveis: `assistant`	Yes

OpenAI.ResponsesAssistantMessageItemResource

Um item de recurso de mensagem com a função assistant.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `assistant`. Valores possíveis: `assistant`	Yes

OpenAI.ResponsesDeveloperMessageItemParam

Um item de parâmetro de mensagem com a função developer.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `developer`. Valores possíveis: `developer`	Yes

OpenAI.ResponsesDeveloperMessageItemResource

Um item de recurso de mensagem com a função developer.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `developer`. Valores possíveis: `developer`	Yes

OpenAI.ResponsesMessageItemParam

Um item de mensagem de resposta, que representa uma função e um conteúdo, conforme fornecido como parâmetros de solicitação do cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

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

Valor do tipo	Esquema
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

Nome	Tipo	Descrição	Obrigatório	Padrão
função	objeto	A coleção de funções válidas para itens de mensagem de respostas.	Yes
tipo	enumeração	O tipo do item de respostas, que é sempre "mensagem". Valores possíveis: `message`	Yes

OpenAI.ResponsesMessageItemResource

Um item de recurso de mensagem de resposta, que representa uma função e um conteúdo, conforme fornecido nas respostas do serviço.

Discriminador para OpenAI.ResponsesMessageItemResource

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

Valor do tipo	Esquema
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

Nome	Tipo	Descrição	Obrigatório
função	objeto	A coleção de funções válidas para itens de mensagem de respostas.	Yes
status	enumeração	O status do item. Um de `in_progress`, `completed`, ou `incomplete`. Populado quando os itens são retornados por meio da API. Valores possíveis: `in_progress`, , `completedincomplete`	Yes
tipo	enumeração	O tipo do item de respostas, que é sempre "mensagem". Valores possíveis: `message`	Yes

OpenAI.ResponsesMessageRole

A coleção de funções válidas para itens de mensagem de respostas.

Propriedade	Valor
Descrição	A coleção de funções válidas para itens de mensagem de respostas.
Tipo	cadeia
Valores	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

Um item de parâmetro de mensagem com a função system.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `system`. Valores possíveis: `system`	Yes

OpenAI.ResponsesSystemMessageItemResource

Um item de recurso de mensagem com a função system.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `system`. Valores possíveis: `system`	Yes

OpenAI.ResponsesUserMessageItemParam

Um item de parâmetro de mensagem com a função user.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `user`. Valores possíveis: `user`	Yes

OpenAI.ResponsesUserMessageItemResource

Um item de recurso de mensagem com a função user.

Nome	Tipo	Descrição	Obrigatório	Padrão
conteúdo	matriz	O conteúdo associado à mensagem.	Yes
função	enumeração	A função da mensagem, que é sempre `user`. Valores possíveis: `user`	Yes

OpenAI.RunGraderRequest

Nome	Tipo	Descrição	Obrigatório
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Não
└─ graders	objeto		Não
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ sampling_params		Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não
item		O item de conjunto de dados fornecido ao avaliador. Isso será usado para preencher o `item` namespace. Consulte o guia para obter mais detalhes.	Não
model_sample	cadeia	O exemplo de modelo a ser avaliado. Esse valor será usado para preencher o `sample` namespace. Consulte o guia para obter mais detalhes. A `output_json` variável será preenchida se o exemplo de modelo for um cadeia de caracteres JSON válida.	Yes

OpenAI.RunGraderResponse

Nome	Tipo	Obrigatório
metadados	objeto	Yes
└─ erros	objeto	Não
└─ erro_de_análise_de_fórmula	boolean	Não
└─ erro_de_variável_inválida (invalid_variable_error)	boolean	Não
└─ model_grader_parse_error	boolean	Não
└─ model_grader_refusal_error	boolean	Não
└─ model_grader_server_error	boolean	Não
└─ model_grader_server_error_details	cadeia	Não
└─ outro_erro	boolean	Não
└─ python_grader_runtime_error	boolean	Não
└─ python_grader_runtime_error_details	cadeia	Não
└─ Erro do Servidor de Avaliação Python	boolean	Não
└─ tipo_de_erro_do_servidor_python_grader	cadeia	Não
Erro_de_Análise_de_Exemplo	boolean	Não
└─ truncated_observation_error	boolean	Não
└─ unresponsive_reward_error	boolean	Não
└─ tempo_de_execução	número	Não
└─ nome	cadeia	Não
└─ nome_modelo_amostrado	cadeia	Não
└─ pontuações		Não
└─ uso_de_token	inteiro	Não
└─ tipo	cadeia	Não
model_grader_token_usage_per_model		Yes
recompensa	número	Yes
sub_rewards		Yes

OpenAI.StaticChunkingStrategy

Nome	Tipo	Descrição	Obrigatório	Padrão
chunk_overlap_tokens	inteiro	O número de tokens que se sobrepõem entre as partes. O valor padrão é `400`. Observe que a sobreposição não deve exceder metade de `max_chunk_size_tokens`.	Yes
max_chunk_size_tokens	inteiro	O número máximo de tokens em cada parte. O valor padrão é `800`. O valor mínimo é `100` e o valor máximo é `4096`.	Yes

OpenAI.StaticChunkingStrategyRequestParam

Personalize sua própria estratégia de agrupamento definindo o tamanho da parte e a sobreposição das partes.

Nome	Tipo	Descrição	Obrigatório	Padrão
estático	OpenAI.StaticChunkingStrategy		Yes
tipo	enumeração	Sempre `static`. Valores possíveis: `static`	Yes

OpenAI.StaticChunkingStrategyResponseParam

Nome	Tipo	Descrição	Obrigatório	Padrão
estático	OpenAI.StaticChunkingStrategy		Yes
tipo	enumeração	Sempre `static`. Valores possíveis: `static`	Yes

OpenAI.StopConfiguration

Não há suporte para modelos de raciocínio o3 e o4-minimais recentes.

Até quatro sequências nas quais a API irá parar de gerar tokens. O texto retornado não conterá a sequência de parada.

Esse esquema aceita um dos seguintes tipos:

cadeia de caracteres
array

OpenAI.Tool

Discriminador para OpenAI.Tool

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

Valor do tipo	Esquema
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ToolType	Uma ferramenta que pode ser usada para gerar uma resposta.	Yes

OpenAI.ToolChoiceObject

Discriminador para OpenAI.ToolChoiceObject

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

Valor do tipo	Esquema
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`function`	OpenAI.ToolChoiceObjectFunction
`mcp`	OpenAI.ToolChoiceObjectMCP

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.ToolChoiceObjectType	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.	Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `code_interpreter`	Yes

OpenAI.ToolChoiceObjectComputer

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `computer_use_preview`	Yes

OpenAI.ToolChoiceObjectFileSearch

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `file_search`	Yes

OpenAI.ToolChoiceObjectFunction

Use essa opção para forçar o modelo a chamar uma função específica.

Nome	Tipo	Descrição	Obrigatório	Padrão
nome	cadeia	O nome da função a ser chamada.	Yes
tipo	enumeração	Para a chamada de função, o tipo é sempre `function`. Valores possíveis: `function`	Yes

OpenAI.ToolChoiceObjectImageGen

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `image_generation`	Yes

OpenAI.ToolChoiceObjectMCP

Use essa opção para forçar o modelo a chamar uma ferramenta específica em um servidor MCP remoto.

Nome	Tipo	Descrição	Obrigatório
nome	cadeia	O nome da ferramenta a ser chamada no servidor.	Não
etiqueta_do_servidor	cadeia	O rótulo do servidor MCP a ser usado.	Yes
tipo	enumeração	Quanto ás ferramentas MCP, o tipo será sempre `mcp`. Valores possíveis: `mcp`	Yes

OpenAI.ToolChoiceObjectType

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.

Propriedade	Valor
Descrição	Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.

Tipo	cadeia
Valores	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	Valores possíveis: `web_search_preview`	Yes

OpenAI.ToolChoiceOptions

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.

Propriedade	Valor
Descrição	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.
Tipo	cadeia
Valores	`none` `auto` `required`

OpenAI.ToolType

Uma ferramenta que pode ser usada para gerar uma resposta.

Propriedade	Valor
Descrição	Uma ferramenta que pode ser usada para gerar uma resposta.
Tipo	cadeia
Valores	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell`

OpenAI.TopLogProb

A probabilidade de log superior de um token.

Nome	Tipo	Obrigatório
bytes	matriz	Yes
logprob	número	Yes
símbolo	cadeia	Yes

OpenAI.UpdateVectorStoreFileAttributesRequest

Nome	Tipo	Descrição	Obrigatório	Padrão
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Yes

OpenAI.UpdateVectorStoreRequest

Nome	Tipo	Descrição	Obrigatório
expires_after	objeto	A política de expiração de um repositório de vetores.	Não
└─ âncora	enumeração	Carimbo de data/hora da âncora após o qual a política de expiração se aplica. Âncoras com suporte: `last_active_at`. Valores possíveis: `last_active_at`	Não
└─ dias	inteiro	O número de dias após o tempo de ancoragem em que o repositório de vetores expirará.	Não
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Não
nome	cadeia	O nome do repositório de vetores.	Não

OpenAI.ValidateGraderRequest

Nome	Tipo	Descrição	Obrigatório
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Yes
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Não
└─ graders	objeto		Não
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ sampling_params		Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não

OpenAI.ValidateGraderResponse

Nome	Tipo	Descrição	Obrigatório
motoniveladora	objeto	Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.	Não
└─ calculate_output	cadeia	Uma fórmula para calcular a saída com base nos resultados do avaliador.	Não
└─ métrica_de_avaliação	enumeração	A métrica de avaliação a ser usada. Um de `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5` ou `rouge_l`. Valores possíveis: `fuzzy_match`, , `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, , `rouge_3`, `rouge_4`, , , , `rouge_5rouge_l`	Não
└─ graders	objeto		Não
└─ etiqueta_de_imagem	cadeia	A marca da imagem a ser usada no script python.	Não
└─ entrada	matriz	O texto de entrada. Isso pode incluir cadeias de caracteres de modelo.	Não
└─ modelo	cadeia	O modelo a ser usado para a avaliação.	Não
└─ nome	cadeia	O nome do avaliador.	Não
└─ Operação	enumeração	A operação de verificação de cadeia de caracteres a ser executada. Uma opção entre `eq`, `ne`, `like` ou `ilike`. Valores possíveis: `eq`, , `ne`, `likeilike`	Não
└─ intervalo	matriz	O intervalo da pontuação. Usa `[0, 1]` como padrão.	Não
└─ Referência	cadeia	O texto de referência para avaliação.	Não
└─ sampling_params		Os parâmetros de amostragem do modelo.	Não
└─ origem	cadeia	O código-fonte do script python.	Não
└─ tipo	enumeração	O tipo de objeto, que é sempre `multi`. Valores possíveis: `multi`	Não

OpenAI.VectorStoreExpirationAfter

A política de expiração de um repositório de vetores.

Nome	Tipo	Descrição	Obrigatório	Padrão
âncora	enumeração	Carimbo de data/hora da âncora após o qual a política de expiração se aplica. Âncoras com suporte: `last_active_at`. Valores possíveis: `last_active_at`	Yes
dias	inteiro	O número de dias após o tempo de ancoragem em que o repositório de vetores expirará.	Yes

OpenAI.VectorStoreFileAttributes

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, boolianos ou números.

Tipo: objeto

OpenAI.VectorStoreFileBatchObject

Um lote de arquivos anexados a um repositório de vetores.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) de quando o lote de arquivos do repositório de vetores foi criado.	Yes
file_counts	objeto		Yes
└─ cancelados	inteiro	O número de arquivos que foram cancelados.	Não
└─ concluídos	inteiro	O número de arquivos que foram processados.	Não
└─ falha	inteiro	O número de arquivos que falharam ao processar.	Não
└─ em andamento	inteiro	O número de arquivos que estão sendo processados no momento.	Não
└─ total	inteiro	O número total de arquivos.	Não
id	cadeia	O identificador, que pode ser referenciado em pontos de extremidade de API.	Yes
objeto	enumeração	O tipo de objeto, que é sempre `vector_store.file_batch`. Valores possíveis: `vector_store.files_batch`	Yes
status	enumeração	O status do lote de arquivos do repositório de vetores, que pode ser `in_progress`, `completed`, `cancelled` ou `failed`. Valores possíveis: `in_progress`, , `completed`, `cancelledfailed`	Yes
vector_store_id	cadeia	A ID do repositório de vetores ao qual o Arquivo está anexado.	Yes

OpenAI.VectorStoreFileObject

Uma lista de arquivos anexados a um repositório de vetores.

Nome	Tipo	Descrição	Obrigatório
attributes	objeto	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 de maneira estruturada formatar e consultar objetos por meio da API ou do painel. Chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo comprimento de 512 caracteres, boolianos ou números.	Não
chunking_strategy	objeto		Não
└─ tipo	enumeração	Valores possíveis: `static`, `other`	Não
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) de quando o repositório de vetores foi criado.	Yes
id	cadeia	O identificador, que pode ser referenciado em pontos de extremidade de API.	Yes
last_error	objeto	O último erro associado a esse arquivo do repositório de vetores. Será `null` se não houver erros.	Yes
└─ código	enumeração	Uma opção entre `server_error` ou `rate_limit_exceeded`. Valores possíveis: `server_error`, , `unsupported_fileinvalid_file`	Não
Mensagem └─	cadeia	Uma descrição do erro legível para humanos.	Não
objeto	enumeração	O tipo de objeto, que é sempre `vector_store.file`. Valores possíveis: `vector_store.file`	Yes
status	enumeração	O status do arquivo do repositório de vetores, que pode ser `in_progress`, `completed`, `cancelled` ou `failed`. O status `completed` indica que o arquivo do repositório de vetores está pronto para uso. Valores possíveis: `in_progress`, , `completed`, `cancelledfailed`	Yes
usage_bytes	inteiro	O uso total do repositório de vetores em bytes. Observe que isso pode ser diferente do tamanho do arquivo original.	Yes
vector_store_id	cadeia	A ID do repositório de vetores ao qual o Arquivo está anexado.	Yes

OpenAI.VectorStoreObject

Um repositório de vetores é uma coleção de arquivos processados que pode ser usado pela ferramenta file_search.

Nome	Tipo	Descrição	Obrigatório
criado_em	inteiro	O carimbo de data/hora Unix (em segundos) de quando o repositório de vetores foi criado.	Yes
expires_after	OpenAI.VectorStoreExpirationAfter	A política de expiração de um repositório de vetores.	Não
expira_em	inteiro	O carimbo de data/hora Unix (em segundos) de quando o repositório de vetores expirará.	Não
file_counts	objeto		Yes
└─ cancelados	inteiro	O número de arquivos que foram cancelados.	Não
└─ concluídos	inteiro	O número de arquivos que foram processados com sucesso.	Não
└─ falha	inteiro	O número de arquivos que falharam ao processar.	Não
└─ em andamento	inteiro	O número de arquivos que estão sendo processados no momento.	Não
└─ total	inteiro	O número total de arquivos.	Não
id	cadeia	O identificador, que pode ser referenciado em pontos de extremidade de API.	Yes
last_active_at	inteiro	O carimbo de data/hora Unix (em segundos) de quando o repositório de vetores esteve ativo pela última vez.	Yes
metadados	objeto	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 de maneira estruturada formatar 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. Valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.	Yes
nome	cadeia	O nome do repositório de vetores.	Yes
objeto	enumeração	O tipo de objeto, que é sempre `vector_store`. Valores possíveis: `vector_store`	Yes
status	enumeração	O status do repositório de vetores, que pode ser `expired`, `in_progress` ou `completed`. Um status de `completed` indica que o repositório de vetores está pronto para uso. Valores possíveis: `expired`, , `in_progresscompleted`	Yes
usage_bytes	inteiro	O número total de bytes usados pelos arquivos no repositório de vetores.	Yes

OpenAI.VoiceIdsShared

Propriedade	Valor
Tipo	cadeia
Valores	`alloy` `ash` `ballad` `coral` `echo` `fable` `onyx` `nova` `sage` `shimmer` `verse`

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Valor do tipo	Esquema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	OpenAI.WebSearchActionType		Yes

OpenAI.WebSearchActionFind

Tipo de ação "localizar": pesquisa um padrão em uma página carregada.

Nome	Tipo	Descrição	Obrigatório
padrão	cadeia	O padrão ou texto a ser pesquisado na página.	Yes
tipo	enumeração	O tipo de ação. Valores possíveis: `find`	Yes
url	cadeia	A URL da página pesquisou o padrão.	Yes

OpenAI.WebSearchActionOpenPage

Tipo de ação "open_page" - abre uma URL específica dos resultados da pesquisa.

Nome	Tipo	Descrição	Obrigatório	Padrão
tipo	enumeração	O tipo de ação. Valores possíveis: `open_page`	Yes
url	cadeia	A URL aberta pelo modelo.	Yes

OpenAI.WebSearchActionSearch

Tipo de ação "pesquisa" - Executa uma consulta de pesquisa na Web.

Nome	Tipo	Descrição	Obrigatório	Padrão
consulta	cadeia	A consulta de pesquisa.	Yes
tipo	enumeração	O tipo de ação. Valores possíveis: `search`	Yes

OpenAI.WebSearchActionType

Propriedade	Valor
Tipo	cadeia
Valores	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
tamanho_do_contexto_de_busca	enumeração	Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Uma opção entre `low`, `medium` ou `high`. `medium` é o padrão. Valores possíveis: `low`, , `mediumhigh`	Não
tipo	enumeração	O tipo da ferramenta de pesquisa na Web. Uma opção entre `web_search_preview` ou `web_search_preview_2025_03_11`. Valores possíveis: `web_search_preview`	Yes
localização_do_usuario	objeto		Não
└─ tipo	OpenAI.LocationType		Não

OpenAI.WebSearchToolCallItemParam

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
ação	objeto		Yes
└─ tipo	OpenAI.WebSearchActionType		Não
tipo	enumeração	Valores possíveis: `web_search_call`	Yes

OpenAI.WebSearchToolCallItemResource

Observação

web_search ainda não está disponível por meio do OpenAI do Azure.

Nome	Tipo	Descrição	Obrigatório
ação	objeto		Yes
└─ tipo	OpenAI.WebSearchActionType		Não
status	enumeração	O status da chamada da ferramenta de pesquisa na Web. Valores possíveis: `in_progress`, , `searching`, `completedfailed`	Yes
tipo	enumeração	Valores possíveis: `web_search_call`	Yes

PineconeChatDataSource

Nome	Tipo	Descrição	Obrigatório	Padrão
parâmetros	objeto	As informações de parâmetro para controlar o uso da fonte de dados Pinecone.	Yes
└─ permitir_resultado_parcial	boolean	Se definido como verdadeiro, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falham. Se isso não for especificado ou especificado como falso, a solicitação falhará caso uma consulta de pesquisa falhe.	Não	Falso
└─ autenticação	objeto		Não
└─ chave	cadeia		Não
└─ tipo	enumeração	Valores possíveis: `api_key`	Não
└─ embedding_dependency	objeto	Uma representação de uma fonte de vetorização de dados utilizável como um recurso de inserção com uma fonte de dados.	Não
└─ tipo	AzureChatDataSourceVectorizationSourceType	O identificador de diferenciação para a fonte de vetorização concreta.	Não
└─ ambiente	cadeia	O nome do ambiente a ser usado com Pinecone.	Não
└─ mapeamento_de_campos	objeto	Mapeamentos de campo a serem aplicados aos dados usados pela fonte de dados do Pinecone. Observe que os mapeamentos de campo de conteúdo são necessários para o Pinecone.	Não
└─ campos_de_conteúdo	matriz		Não
└─ separador_dos_campos_de_conteúdo	cadeia		Não
└─ campo_caminho_do_arquivo	cadeia		Não
└─ campo_do_título	cadeia		Não
└─ campo_de_url	cadeia		Não
└─ in_scope	boolean	Se as consultas devem ser restritas ao uso dos dados indexados.	Não
└─ incluir_contextos	matriz	As propriedades de contexto de saída a serem incluídas na resposta. Por padrão, as citações e a intenção serão solicitadas.	Não	['citações', 'intenções']
└─ nome_do_índice	cadeia	O nome do índice de banco de dados Pinecone a ser usado.	Não
└─ consultas_de_busca_máximas	inteiro	O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário. Por padrão, o sistema fará uma determinação automática.	Não
└─ rigidez	inteiro	A rigorosidade configurada da filtragem de relevância da pesquisa. A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.	Não
└─ top_n_documents	inteiro	O número configurado de documentos a serem apresentados na consulta.	Não
tipo	enumeração	O identificador de tipo discriminado, que é sempre "pinecone". Valores possíveis: `pinecone`	Yes

ResponseFormatJSONSchemaRequest

Nome	Tipo	Descrição	Obrigatório	Padrão
json_schema	objeto	Esquema JSON para o formato de resposta	Yes
tipo	enumeração	Tipo de formato de resposta Valores possíveis: `json_schema`	Yes

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 modelo gpt-4o-audio-preview também pode ser usado para gerar áudio. Para solicitar que esse modelo gere respostas de texto e áudio, você pode usar:

["text", "audio"]

Matriz de: string

Comentários

Esta página foi útil?

Last updated on 2025-11-26

Compartilhar via

Referência da API REST do Azure OpenAI no Microsoft Foundry Models v1

Criar conclusão de chat

Parâmetros

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Exemplos

Exemplo

Criar inserção

Parâmetros

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Exemplos

Exemplo

Listar valores

Parâmetros

Cabeçalho da solicitação

Respostas

Criar avaliação

Parâmetros

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Obter avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Atualizar a avaliação

Parâmetros

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Excluir a avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Obter execuções de avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Criar execução de avaliação

Parâmetros

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Obter execução de avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Cancelar execução de avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Excluir execução de avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Obter itens de saída de execução de avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Obter item de saída de execução de avaliação

Parâmetros

Cabeçalho da solicitação

Respostas

Criar arquivo

Parâmetros

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Exemplos

Exemplo

Listar arquivos

Parâmetros

Cabeçalho da solicitação

Respostas

Recuperar o arquivo

Parâmetros