Partilhar via

Referência da API REST do Azure OpenAI nos Modelos Microsoft Foundry v1

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

Criar conclusão de chat

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

Cria uma conclusão de chat.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Microsoft Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
áudio objecto 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 de áudio de saída. Deve ser um dos wav, mp3, flac,
opus, ou pcm16.
Valores possíveis: wav, aac, mp3, flac, , opus, pcm16		 Não
└─ voz objecto Não
data_sources matriz As fontes de dados a serem usadas para o recurso On Your Data, exclusivo do Azure OpenAI. Não
penalização de frequência 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
probabilidade de repetir literalmente a mesma linha.		 Não 0
function_call enumeração Especificar uma função específica através {"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 objecto Modifique a probabilidade de tokens especificados aparecerem na conclusão.

Aceita um objeto JSON que mapeia tokens (especificado por sua ID de token na
tokenizer) para um valor de viés associado de -100 a 100. Matematicamente,
O viés é adicionado aos logits gerados pelo modelo antes da amostragem.
O efeito exato varia de acordo com o modelo, mas os valores entre -1 e 1 devem
diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100
deve resultar numa proibição ou seleção exclusiva do token relevante.		 Não Nenhum
Logprobs Booleano Se deve retornar as probabilidades de log dos tokens de saída ou não. Se for verdade,
retorna as probabilidades de log de cada token de saída retornado no
content de message.		 Não Falso
max_completion_tokens número inteiro Um limite superior para o número de tokens que podem ser gerados para um
conclusão, incluindo tokens de saída visíveis e tokens de raciocínio.		 Não
máximo de tokens número inteiro O número máximo de tokens que podem ser gerados na conclusão do chat.
Esse valor pode ser usado para controlar os custos do texto gerado via API.

Este valor é agora 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 compõem a conversa até agora. Dependendo do
modelo que você usa, diferentes tipos de mensagem (modalidades) são suportados,
como texto, imagens e áudio.		 Yes
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
Modalidades objecto Tipos de saída que você gostaria que o modelo gerasse.
A maioria dos modelos são capazes de gerar texto, que é o padrão:

["text"]

O gpt-4o-audio-preview modelo também pode ser usado para gerar áudio. Para solicitar que este modelo gere
Respostas de texto e áudio, você pode usar:

["text", "audio"]		 Não
modelo cadeia (de caracteres) O identificador de implantação do modelo a ser usado para a solicitação de conclusão do chat. Yes
n número inteiro Quantas opções de conclusão de chat gerar para cada mensagem de entrada. Observe que você será cobrado com base no número de tokens gerados em todas as opções. Manter n como 1 minimizar custos. Não 1
chamadas_de_ferramentas_em_paralelo objecto Se a chamada de função paralela deve ser ativada durante o uso da ferramenta. Não
predição objecto Representação de base da saída prevista de um modelo. Não
└─ tipo OpenAI.ChatOutputPredictionType Não
penalização por 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 temas.		 Não 0
esforço de raciocínio objecto apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
formato_de_resposta objecto Não
└─ tipo enumeração
Valores possíveis: text, json_object, json_schema		 Não
sementes número inteiro Este recurso está em versão Beta.
Se especificado, nosso sistema fará um melhor esforço para amostragem determinística, de modo que solicitações repetidas com os mesmos seed parâmetros e devem retornar o mesmo resultado.
O determinismo não é garantido e você deve consultar o system_fingerprint parâmetro response para monitorar as alterações no back-end.		 Não
pare objecto Não suportado com os modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências onde a API deixará de gerar mais tokens. O
O texto retornado não conterá a sequência de parada.		 Não
armazenar Booleano Armazenar ou não a saída desta solicitação de conclusão de bate-papo para
utilização em modelos de destilação ou em produtos evals.		 Não Falso
fluxo Booleano Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente
como é gerado usando eventos enviados pelo servidor.		 Não Falso
stream_options objecto Opções para resposta de streaming. Defina isso apenas quando definir stream: true. Não
└─ include_usage Booleano Se definido, um bloco adicional será transmitido antes do data: [DONE]
Mensagem. O usage campo neste bloco mostra as estatísticas de uso de token
para todo o pedido, e o choices campo será sempre um vazio
matriz.

Todas as outras partes também incluirão um usage campo, mas com um nulo
valor. OBSERVAÇÃO: Se o fluxo for interrompido, você pode não receber o
bloco de uso final que contém o uso total de token para a solicitação.		 Não
temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual (se houver) ferramenta é chamada pelo modelo.
none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.
required significa que o modelo deve chamar uma ou mais ferramentas.
Especificar uma ferramenta específica via {"type": "function", "function": {"name": "my_function"}} força o modelo a chamar essa ferramenta.

none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.		 Não
Ferramentas matriz Uma lista de ferramentas que o modelo pode chamar. Atualmente, apenas funções são suportadas como ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. Um máximo de 128 funções são suportadas. Não
top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não 1
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a
monitorizar e detetar 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 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 for Cloud. Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo Tipo Descrição
application/json AzureCreateChatCompletionResponse
fluxo de texto/evento AzureCreateChatCompletionStreamResponse

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Exemplos

Exemplo

Cria uma conclusão para o prompt fornecido, parâmetros e 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 incorporação

POST {endpoint}/openai/v1/embeddings

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
Dimensões número inteiro O número de dimensões que as incorporações de saída resultantes devem ter. Apenas suportado em text-embedding-3 modelos e modelos posteriores. Não
encoding_format enumeração O formato para retornar as incorporações. Pode ser qualquer um float ou base64.
Valores possíveis: float, base64		 Não
dados introduzidos cadeia de caracteres ou matriz Yes
modelo cadeia (de caracteres) O modelo a ser usado para a solicitação de incorporação. Yes
utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Exemplos

Exemplo

Retorne as incorporaçõ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
    }
  }
}

Lista de evals

GET {endpoint}/openai/v1/evals

Listar avaliações de um projeto.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
after consulta Não cadeia (de caracteres) Identificador da última avaliação da solicitação de paginação anterior.
limite consulta Não número inteiro Um limite no número de evals a serem retornados em uma única resposta de paginação.
Ordem / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordem de ordenação das avaliações por carimbo de data/hora. Utilização asc por ordem crescente ou
desc por ordem decrescente.
ordenar por consulta Não cadeia (de caracteres)
Valores possíveis: created_at, updated_at		 Os Evals podem ser ordenados por hora de criação ou hora da última atualização. Utilização
created_at para o tempo de criação ou updated_at para a última atualização
Hora.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar eval

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. Suportamos vários tipos de classificadores e fontes de dados.

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
configuração_fonte_dados objecto Yes
└─ tipo OpenAI.EvalDataSourceConfigType Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) O nome da avaliação. Não
código de estado enumeração
Valores possíveis: 201		 Yes
critérios_teste matriz Uma lista de classificadores 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 fazer referência à saída do modelo, use o sample namespace (ou seja, {{sample.output_text}}). Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Obter eval

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

Recupere uma avaliação pelo seu ID. Recupera uma avaliação por seu ID.

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Atualização eval

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

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

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
metadados OpenAI.MetadataPropertyForRequest Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Excluir eval

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

Exclua uma avaliação especificada.

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Obter corridas eval

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 Azure OpenAI está em pré-visualização e sujeita a alterações.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)
after consulta Não cadeia (de caracteres)
limite consulta Não número inteiro
Ordem / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc
estado consulta Não cadeia (de caracteres)
Valores possíveis: queued, in_progress, completed, canceled, , failed

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar execução eval

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

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

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
fonte_de_dados objecto Yes
└─ tipo OpenAI.EvalRunDataSourceType Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) O nome da execução. Não

Respostas

Código de status: 201

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

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Comece a correr eval

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

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

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)
identificador_de_execução caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Cancelar execução eval

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

Cancelar uma avaliação específica executada pelo seu ID.

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)
identificador_de_execução caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Excluir execução eval

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

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

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)
identificador_de_execução caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

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

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 Azure OpenAI está em pré-visualização e sujeita a alterações.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)
identificador_de_execução caminho Yes cadeia (de caracteres)
after consulta Não cadeia (de caracteres)
limite consulta Não número inteiro
estado consulta Não cadeia (de caracteres)
Valores possíveis: fail, pass
Ordem / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

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

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 seu ID.

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Aoai-Evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso ao AOAI Evals, um recurso de visualização.
Este recurso requer que o cabeçalho 'aoai-evals' seja definido como 'preview'.
eval_id caminho Yes cadeia (de caracteres)
identificador_de_execução caminho Yes cadeia (de caracteres)
output_item_id caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar ficheiro

POST {endpoint}/openai/v1/files

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: multipart/form-data

Nome Tipo Descrição Obrigatório Predefinido
expira após objecto Yes
└─ âncora AzureFileExpiryAnchor Não
└─ segundos número inteiro Não
ficheiro cadeia (de caracteres) Yes
Finalidade enumeração A finalidade pretendida do ficheiro carregado. Um dos seguintes: - assistants: Usado na API de assistentes - batch: Usado na API de lote - fine-tune: Usado para ajuste fino - evals: Usado para conjuntos de dados eval
Valores possíveis: assistants, batch, fine-tune, evals		 Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Exemplos

Exemplo

POST {endpoint}/openai/v1/files

Listar ficheiros

GET {endpoint}/openai/v1/files

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
Finalidade consulta Não cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Recuperar arquivo

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
identificação_de_ficheiro caminho Yes cadeia (de caracteres) A ID do arquivo a ser usado para essa solicitação.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Eliminar ficheiro

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
identificação_de_ficheiro caminho Yes cadeia (de caracteres) A ID do arquivo a ser usado para essa solicitação.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Descarregar ficheiro

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
identificação_de_ficheiro caminho Yes cadeia (de caracteres) A ID do arquivo a ser usado para essa solicitação.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Executar motoniveladora

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

Execute uma motoniveladora.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
Motoniveladora objecto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calcular_saída cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Não
└─ métrica_de_avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Não
└─ Motoniveladoras objecto Não
└─ tag de imagem cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
└─ entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Não
└─ modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Não
└─ nome cadeia (de caracteres) O nome do classificador. Não
└─ operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Não
└─ gama matriz O intervalo da pontuação. O padrão é [0, 1]. Não
└─ referência cadeia (de caracteres) O texto que está a ser avaliado. Não
└─ parâmetros_de_amostragem Os parâmetros de amostragem para o modelo. Não
└─ fonte cadeia (de caracteres) 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 do conjunto de dados fornecido ao classificador. Isso será usado para preencher
o item namespace. Consulte o guia para obter mais detalhes.		 Não
model_sample cadeia (de caracteres) A amostra modelo a ser avaliada. Esse valor será usado para preencher
o sample namespace. Consulte o guia para obter mais detalhes.
A output_json variável será preenchida se a amostra do modelo for um
cadeia de caracteres JSON válida.		 Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Validar classificador

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

Valide uma classificadora.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
Motoniveladora objecto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calcular_saída cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Não
└─ métrica_de_avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Não
└─ Motoniveladoras objecto Não
└─ tag de imagem cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
└─ entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Não
└─ modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Não
└─ nome cadeia (de caracteres) O nome do classificador. Não
└─ operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Não
└─ gama matriz O intervalo da pontuação. O padrão é [0, 1]. Não
└─ referência cadeia (de caracteres) O texto que está a ser avaliado. Não
└─ parâmetros_de_amostragem Os parâmetros de amostragem para o modelo. Não
└─ fonte cadeia (de caracteres) 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: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar 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 depois de concluídos.

Saiba mais sobre ajuste fino

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
hiperparâmetros objecto Os hiperparâmetros usados para o trabalho de ajuste fino.
Esse valor agora é preterido em favor de method, e deve ser passado sob o method parâmetro.		 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 objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
método Método OpenAI.FineTune O método utilizado para o ajuste fino. Não
modelo string (ver modelos válidos abaixo) O nome do modelo a ser ajustado. Pode selecionar uma das opções
modelos suportados.		 Yes
sementes número inteiro A semente controla a reprodutibilidade do trabalho. Fornecer os mesmos parâmetros de semente e de trabalho deve produzir os mesmos resultados, mas poderá diferir em casos raros.
Se uma semente não for especificada, uma será gerada para você.		 Não
sufixo cadeia (de caracteres) Uma cadeia de até 64 caracteres que será adicionada ao nome do modelo ajustado.

Por exemplo, um suffix de "custom-model-name" produziria um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 Não Nenhum
ficheiro de treino cadeia (de caracteres) A ID de um arquivo carregado que contém dados de treinamento.

Consulte Carregar ficheiro para saber como carregar um ficheiro.

Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve fazer o upload do seu arquivo com a finalidade fine-tune.

O conteúdo do arquivo deve diferir dependendo se o modelo usa o bate-papo 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
ficheiro_de_validação cadeia (de caracteres) A ID de um arquivo carregado que contém dados de validação.

Se você fornecer esse arquivo, os dados serão usados para gerar validação
métricas periodicamente durante o ajuste fino. Essas métricas podem ser visualizadas em
O arquivo de resultados de ajuste fino.
Os mesmos dados não devem estar presentes nos processos de comboio e de validação.

Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve fazer o upload do 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: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Listar trabalhos de ajuste fino paginados

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

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
after consulta Não cadeia (de caracteres) Identificador do último trabalho da solicitação de paginação anterior.
limite consulta Não número inteiro Número de trabalhos de ajuste fino a serem recuperados.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Recuperar 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 In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres) A ID do trabalho de ajuste fino.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Cancelar 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 In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres) A ID do trabalho de ajuste fino a ser cancelado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo Tipo Descrição
application/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 In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres) A ID do trabalho de ajuste fino para obter pontos de verificação.
after consulta Não cadeia (de caracteres) Identificador do último ID de ponto de verificação da solicitação de paginação anterior.
limite consulta Não número inteiro Número de pontos de verificação a recuperar.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo Tipo Descrição
application/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 e região de destino especificadas.

Observação

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
pontos de verificação aoai-copy-ft- cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso a operações de cópia de ponto de verificação para modelos, um recurso de visualização da AOAI.
Este recurso requer que o cabeçalho 'aoai-copy-ft-checkpoints' seja definido como 'preview'.
aceitar cabeçalho Yes cadeia (de caracteres)
Valores possíveis: application/json
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres)
fine_tuning_checkpoint_name caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
destinationResourceId cadeia (de caracteres) A ID do Recurso de destino a ser copiado. Yes
região cadeia (de caracteres) A região para a qual copiar o modelo. Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo Tipo Descrição
application/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 Azure OpenAI está em pré-visualização e sujeita a alterações.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
pontos de verificação aoai-copy-ft- cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso a operações de cópia de ponto de verificação para modelos, um recurso de visualização da AOAI.
Este recurso requer que o cabeçalho 'aoai-copy-ft-checkpoints' seja definido como 'preview'.
aceitar cabeçalho Yes cadeia (de caracteres)
Valores possíveis: application/json
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres)
fine_tuning_checkpoint_name caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo Tipo Descrição
application/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 In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres) A ID do trabalho de ajuste fino para obter eventos.
after consulta Não cadeia (de caracteres) Identificador do último evento da solicitação de paginação anterior.
limite consulta Não número inteiro Número de eventos a recuperar.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Pausar o trabalho de ajuste fino

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

Pause um trabalho de ajuste fino.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres) A ID do trabalho de ajuste fino a ser pausado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Retomar o trabalho de ajuste fino

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

Retome um trabalho de ajuste fino pausado.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
ID_de_tarefa_de_ajuste_fino caminho Yes cadeia (de caracteres) A ID do trabalho de ajuste fino a ser retomado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Listar modelos

GET {endpoint}/openai/v1/models

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Recuperar modelo

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

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
modelo caminho Yes cadeia (de caracteres) A ID do modelo a ser usado para essa solicitação.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo Tipo Descrição
application/json OpenAI.Modelo

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar resposta

POST {endpoint}/openai/v1/responses

Cria uma resposta de modelo.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
em segundo plano Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
include matriz Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente
Os valores suportados são:
- code_interpreter_call.outputs: Inclui as saídas de execução de código python
na ferramenta interpretador de código, chamar itens.
- computer_call_output.output.image_url: Inclua urls de imagem da saída de chamada do computador.
- file_search_call.results: Incluir os resultados da pesquisa de
a chamada da ferramenta de pesquisa de ficheiros.
- 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 encriptada do raciocínio
tokens em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em
conversas com vários turnos ao usar a API de respostas sem estado (como
quando o store parâmetro é definido como false, ou quando uma organização é
inscritos no programa de retenção de dados zero).		 Não
dados introduzidos cadeia de caracteres ou matriz Não
instructions cadeia (de caracteres) Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
max_output_tokens número 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 número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
modelo cadeia (de caracteres) A implantação do modelo a ser usado para a criação dessa resposta. Yes
chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
previous_response_id cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
avisar objecto Referência a um modelo de prompt e suas variáveis.
 Não
└─ ID cadeia (de caracteres) O identificador exclusivo do modelo de prompt a ser usado. Não
└─ variáveis OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis em seu
prompt. Os valores de substituição podem ser strings ou outros
Tipos de entrada de resposta, como imagens ou arquivos.		 Não
└─ versão cadeia (de caracteres) Versão opcional do modelo de prompt. Não
Fundamentação objecto apenas modelos de raciocínio

Opções de configuração para
modelos de raciocínio.		 Não
└─ esforço OpenAI.ReasoningEffort apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
└─ gerar_resumo enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
└─ Resumo enumeração Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
armazenar Booleano Se a resposta do modelo gerado deve ser armazenada para recuperação posterior via
API.		 Não Verdade
fluxo Booleano Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente
como é gerado usando eventos enviados pelo servidor.
Veja a seção Streaming abaixo
para mais informações.		 Não Falso
temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não 1
enviar SMS objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto ou dados JSON estruturados. Saiba mais: Saídas estruturadas		 Não
└─ formato OpenAI.ResponseTextFormatConfiguration Não
tool_choice objecto Controla qual (se houver) ferramenta é 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa de arquivos.
- Chamadas de função (ferramentas personalizadas): funções que são definidas por você,
permitindo que o modelo chame seu próprio código.		 Não
top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não 1
truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

Tipo de conteúdo Tipo Descrição
application/json AzureResponse
fluxo de texto/evento OpenAI.ResponseStreamEvent

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Exemplos

Exemplo

Criar uma resposta de modelo

POST {endpoint}/openai/v1/responses

Obter resposta

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

Recupera uma resposta do modelo com a ID fornecida.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
response_id caminho Yes cadeia (de caracteres)
include_obfuscation consulta Não Booleano Quando verdadeiro, a ofuscação de fluxo será ativada. A ofuscação de fluxo adiciona caracteres aleatórios a um obfuscation campo no streaming de eventos delta para normalizar os tamanhos de carga útil como uma atenuação para certos 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 false para otimizar a largura de banda se confiar nos links de rede entre seu aplicativo e a API OpenAI.
incluir[] consulta Não matriz

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Excluir resposta

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

Exclui uma resposta por ID.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
response_id caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

Tipo de conteúdo Tipo Descrição
application/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 In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
response_id caminho Yes cadeia (de caracteres)
limite consulta Não número 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 / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordem de classificação pelo carimbo created_at de data/hora dos objetos. asc por ordem crescente edesc
por ordem decrescente.
after consulta Não cadeia (de caracteres) Um cursor para uso na paginação. after é um ID de objeto que define o 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.
antes consulta Não cadeia (de caracteres) Um cursor para uso na paginação. before é um ID de objeto que define o 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 before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Listar repositórios de vetores

GET {endpoint}/openai/v1/vector_stores

Retorna uma lista de repositórios vetoriais.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
limite consulta Não número 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 / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordem de classificação pelo carimbo created_at de data/hora dos objetos. asc por ordem crescente edesc
por ordem decrescente.
after consulta Não cadeia (de caracteres) Um cursor para uso na paginação. after é um ID de objeto que define o 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.
antes consulta Não cadeia (de caracteres) Um cursor para uso na paginação. before é um ID de objeto que define o 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 before=obj_foo para buscar a página anterior da lista.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Createvectorstore

POST {endpoint}/openai/v1/vector_stores

Cria um repositório vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
chunking_strategy objecto A estratégia padrão. Esta estratégia utiliza atualmente um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400. Não
└─ estático OpenAI.StaticChunkingEstratégia Não
└─ tipo enumeração Sempre static.
Valores possíveis: static		 Não
expira após OpenAI.VectorStoreExpirationAfter A política de expiração para um repositório de vetores. Não
identificadores_de_arquivo matriz Uma lista de IDs de arquivo que o armazenamento de vetores deve usar. Útil para ferramentas como file_search essa podem acessar arquivos. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) O nome do repositório de vetores. Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Exemplos

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

Obter loja de vetores

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

Recupera um armazenamento de vetores.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do repositório de vetores a ser recuperado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Modificar armazenamento vetorial

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

Modifica um armazenamento vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID do repositório de vetores a ser modificado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
expira após objecto A política de expiração para um repositório de vetores. Não
└─ âncora enumeração Carimbo de data/hora âncora após o qual a política de expiração se aplica. Âncoras suportadas: last_active_at.
Valores possíveis: last_active_at		 Não
└─ dias número inteiro O número de dias após o tempo de ancoragem que o armazenamento do vetor expirará. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) O nome do repositório de vetores. Não

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Excluir armazenamento de vetores

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

Exclua um repositório de vetores.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID do repositório de vetores a ser excluído.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar lote de arquivos de armazenamento vetorial

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

Crie um lote de arquivo de armazenamento vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do repositório de vetores para o qual criar um lote de arquivos.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Não
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) arquivo(s). Se não estiver definido, usará a auto estratégia. Não
identificadores_de_arquivo matriz Uma lista de IDs de arquivo que o armazenamento de vetores deve usar. Útil para ferramentas como file_search essa podem acessar arquivos. Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Obter lote de arquivos de armazenamento vetorial

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

Recupera um lote de arquivo de armazenamento vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do armazenamento vetorial ao qual o lote de arquivos pertence.
batch_id caminho Yes cadeia (de caracteres) A ID do lote de arquivos que está sendo recuperado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Cancelar lote de arquivos de armazenamento vetorial

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

Cancele um lote de arquivo de armazenamento vetorial. Isso tenta cancelar o processamento de arquivos neste lote o mais rápido possível.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do armazenamento vetorial ao qual o lote de arquivos pertence.
batch_id caminho Yes cadeia (de caracteres) A ID do lote de arquivos a ser cancelado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Listar arquivos em lote de armazenamento vetorial

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

Retorna uma lista de arquivos de armazenamento vetorial em um lote.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do armazenamento vetorial ao qual o lote de arquivos pertence.
batch_id caminho Yes cadeia (de caracteres) A ID do lote de arquivos ao qual os arquivos pertencem.
limite consulta Não número 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 / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordem de classificação pelo carimbo created_at de data/hora dos objetos. asc por ordem crescente edesc
por ordem decrescente.
after consulta Não cadeia (de caracteres) Um cursor para uso na paginação. after é um ID de objeto que define o 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.
antes consulta Não cadeia (de caracteres) Um cursor para uso na paginação. before é um ID de objeto que define o 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 before=obj_foo para buscar a página anterior da lista.
filtro consulta Não Filtrar por estado do ficheiro. Um de in_progress, completed, failed, cancelled.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Listar arquivos de armazenamento vetorial

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

Retorna uma lista de arquivos de armazenamento vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do armazenamento vetorial ao qual os arquivos pertencem.
limite consulta Não número 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 / Encomenda consulta Não cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordem de classificação pelo carimbo created_at de data/hora dos objetos. asc por ordem crescente edesc
por ordem decrescente.
after consulta Não cadeia (de caracteres) Um cursor para uso na paginação. after é um ID de objeto que define o 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.
antes consulta Não cadeia (de caracteres) Um cursor para uso na paginação. before é um ID de objeto que define o 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 before=obj_foo para buscar a página anterior da lista.
filtro consulta Não Filtrar por estado do ficheiro. Um de in_progress, completed, failed, cancelled.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Criar arquivo de armazenamento vetorial

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

Crie um arquivo de armazenamento vetorial anexando um arquivo a um repositório vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do repositório de vetores para o qual criar um arquivo.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Não
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) arquivo(s). Se não estiver definido, usará a auto estratégia. Não
identificação_de_ficheiro cadeia (de caracteres) Um ID de arquivo que o armazenamento de vetores deve usar. Útil para ferramentas como file_search essa podem acessar arquivos. Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Obter arquivo de armazenamento vetorial

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

Recupera um arquivo de armazenamento vetorial.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do repositório vetorial ao qual o arquivo pertence.
identificação_de_ficheiro caminho Yes cadeia (de caracteres) A ID do arquivo que está sendo recuperado.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Atualizar atributos de arquivo de armazenamento vetorial

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

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres)
identificação_de_ficheiro caminho Yes cadeia (de caracteres)

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Órgão do Pedido

Tipo de conteúdo: application/json

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Yes

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Excluir arquivo de armazenamento vetorial

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

Exclua um arquivo de armazenamento vetorial. Isso removerá o arquivo do armazenamento vetorial, mas o arquivo em si não será excluído. Para excluir o arquivo, use o ponto de extremidade de exclusão.

Parâmetros

Nome In Obrigatório Tipo Descrição
ponto final caminho Yes cadeia (de caracteres)
URL		 Pontos de extremidade do Azure OpenAI com suporte (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo nome do recurso do Azure OpenAI). https://{seu-nome-de-recurso}.openai.azure.com
Versão da API consulta Não A versão explícita da API Foundry Models para este pedido.
v1 se não especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) A ID do repositório vetorial ao qual o arquivo pertence.
identificação_de_ficheiro caminho Yes cadeia (de caracteres) A ID do arquivo a ser excluído.

Cabeçalho da solicitação

Use autenticação baseada em token ou 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 (de caracteres) 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
Âmbito de aplicação: https://cognitiveservices.azure.com/.default
chave de API Verdade cadeia (de caracteres) Forneça a chave da API do Azure OpenAI aqui

Respostas

Código de status: 200

Descrição: O pedido foi bem-sucedido.

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

Código de status: padrão

Descrição: Uma resposta de erro inesperada.

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

Componentes

AzureAIFoundryModelsApiVersion

Propriedade Valor
Tipo cadeia (de caracteres)
Valores v1
preview

AzureChatCompletionResponseMessage

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

Nome Tipo Descrição Obrigatório Predefinido
anotações matriz Anotações para a mensagem, quando aplicável, como ao usar a ferramenta de pesquisa na web. Não
áudio objecto Se a modalidade de saída de áudio for solicitada, este objeto contém dados
sobre a resposta de áudio do modelo. .		 Não
└─ dados cadeia (de caracteres) Base64 bytes de áudio codificados gerados pelo modelo, no formato
especificado no pedido.		 Não
└─ expira_em número inteiro O carimbo de data/hora do Unix (em segundos) para quando esta resposta de áudio será
não estar mais acessível no servidor para uso em turnos múltiplos
conversas.		 Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta de áudio. Não
└─ Transcrição cadeia (de caracteres) Transcrição do áudio gerado pelo modelo. Não
conteúdo cadeia (de caracteres) O conteúdo da mensagem. Yes
contexto objecto Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzida pelo serviço Azure OpenAI ao usar
comportamento de extensão. Isso inclui informações de intenção e citação do recurso Em seus dados.		 Não
└─ todas_os_documentos_recuperados objecto Informações resumidas sobre documentos recuperados pela operação de recuperação de dados. Não
└─ chunk_id cadeia (de caracteres) O ID do bloco para a citação. Não
└─ conteúdo cadeia (de caracteres) O conteúdo da citação. Não
└─ índice_de_fonte_de_dados número inteiro O índice da fonte de dados usada para recuperação. Não
└─ caminho do arquivo cadeia (de caracteres) O caminho do arquivo para a citação. Não
└─ motivo_do_filtro enumeração Se aplicável, indicação do motivo pelo qual o documento foi filtrado.
Valores possíveis: score, rerank		 Não
└─ pontuação_original_de_pesquisa número A pontuação de pesquisa original para a recuperação. Não
└─ pontuação_reclassificação número A pontuação de reclassificação para a recuperação. Não
└─ consultas_de_pesquisa matriz As consultas de pesquisa executadas para recuperar documentos. Não
└─ título cadeia (de caracteres) O título da citação. Não
└─ URL cadeia (de caracteres) O URL da citação. Não
└─ citações matriz As citações produzidas pela recuperação de dados. Não
└─ intenção cadeia (de caracteres) A intenção detetada do histórico de bate-papo, que é usado para transportar o contexto da conversa entre as interações Não
function_call objecto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. Não
└─ argumentos cadeia (de caracteres) Não
└─ nome cadeia (de caracteres) Não
reasoning_content cadeia (de caracteres) Uma propriedade de extensão específica do Azure que contém conteúdo de raciocínio gerado de modelos suportados. Não
recusa cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. Yes
função enumeração O papel do autor desta 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 Azure OpenAI. Esse modelo adiciona suporte ao contexto de mensagens de bate-papo, usado pelo recurso On Your Data para intenção, citações e outras informações relacionadas à geração aumentada de recuperação realizada.

Nome Tipo Descrição Obrigatório Predefinido
áudio objecto Não
└─ dados cadeia (de caracteres) Não
└─ expira_em número inteiro Não
└─ ID cadeia (de caracteres) Não
└─ Transcrição cadeia (de caracteres) Não
conteúdo cadeia (de caracteres) O conteúdo da mensagem de bloco. Não
contexto objecto Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzida pelo serviço Azure OpenAI ao usar
comportamento de extensão. Isso inclui informações de intenção e citação do recurso Em seus dados.		 Não
└─ todas_os_documentos_recuperados objecto Informações resumidas sobre documentos recuperados pela operação de recuperação de dados. Não
└─ chunk_id cadeia (de caracteres) O ID do bloco para a citação. Não
└─ conteúdo cadeia (de caracteres) O conteúdo da citação. Não
└─ índice_de_fonte_de_dados número inteiro O índice da fonte de dados usada para recuperação. Não
└─ caminho do arquivo cadeia (de caracteres) O caminho do arquivo para a citação. Não
└─ motivo_do_filtro enumeração Se aplicável, indicação do motivo pelo qual o documento foi filtrado.
Valores possíveis: score, rerank		 Não
└─ pontuação_original_de_pesquisa número A pontuação de pesquisa original para a recuperação. Não
└─ pontuação_reclassificação número A pontuação de reclassificação para a recuperação. Não
└─ consultas_de_pesquisa matriz As consultas de pesquisa executadas para recuperar documentos. Não
└─ título cadeia (de caracteres) O título da citação. Não
└─ URL cadeia (de caracteres) O URL da citação. Não
└─ citações matriz As citações produzidas pela recuperação de dados. Não
└─ intenção cadeia (de caracteres) A intenção detetada do histórico de bate-papo, que é usado para transportar o contexto da conversa entre as interações Não
function_call objecto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. Não
└─ argumentos cadeia (de caracteres) Não
└─ nome cadeia (de caracteres) Não
reasoning_content cadeia (de caracteres) Uma propriedade de extensão específica do Azure que contém conteúdo de raciocínio gerado de modelos suportados. Não
recusa cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. Não
função objecto O papel 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 Azure OpenAI. Isso será usado por uma solicitação de conclusão de chat que deve usar as extensões de chat do Azure OpenAI para aumentar o comportamento de resposta. O uso dessa configuração é compatível apenas com o Azure OpenAI.

Discriminador para AzureChatDataSource

Este 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 Predefinido
tipo objecto Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Nome Tipo Descrição Obrigatório Predefinido
access_token cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: access_token		 Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Nome Tipo Descrição Obrigatório Predefinido
chave cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: api_key		 Yes

AzureChatDataSourceAuthenticationOptions

Discriminador para AzureChatDataSourceAuthenticationOptions

Este 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 Predefinido
tipo AzureChatDataSourceAuthenticationOptionsType Yes

AzureChatDataSourceAuthenticationOptionsType

Propriedade Valor
Tipo cadeia (de caracteres)
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 Predefinido
connection_string cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: connection_string		 Yes

AzureChatDataSourceDeploymentNameVectorizationSource

Representa uma fonte de vetorização que faz chamadas de serviço interno em uma implantação de modelo de incorporação do Azure OpenAI. 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 Azure OpenAI, mas pode ser usada mesmo em redes privadas.

Nome Tipo Descrição Obrigatório Predefinido
nome_da_implementação cadeia (de caracteres) A implantação do modelo de incorporação a ser usado para vetorização. Essa implantação deve existir dentro do mesmo Azure OpenAI
como a implantação do modelo que está sendo usado para a conclusão do chat.		 Yes
Dimensões número inteiro O número de dimensões a solicitar nas incorporações.
Suportado apenas em 'text-embedding-3' e modelos posteriores.		 Não
tipo enumeração O identificador de tipo, sempre 'deployment_name' para esse tipo de fonte de vetorização.
Valores possíveis: deployment_name		 Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Nome Tipo Descrição Obrigatório Predefinido
encoded_api_key cadeia (de caracteres) 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 incorporação do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
autenticação objecto Yes
└─ token_de_acesso cadeia (de caracteres) Não
└─ chave cadeia (de caracteres) Não
└─ tipo enumeração
Valores possíveis: access_token		 Não
Dimensões número inteiro O número de dimensões a solicitar nas incorporações.
Suportado apenas em 'text-embedding-3' e modelos posteriores.		 Não
ponto final cadeia (de caracteres) Especifica a URL do ponto de extremidade do recurso a partir da qual as incorporações devem ser recuperadas.
Deve ter o 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 fonte 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 Predefinido
tipo enumeração O identificador de tipo, sempre 'integrado' para este tipo de fonte de vetorização.
Valores possíveis: integrated		 Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Nome Tipo Descrição Obrigatório Predefinido
chave cadeia (de caracteres) Yes
key_id cadeia (de caracteres) 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 um ID de modelo de serviço de pesquisa. Atualmente, esse tipo de fonte é suportado apenas pelo Elasticsearch.

Nome Tipo Descrição Obrigatório Predefinido
model_id cadeia (de caracteres) O ID de compilação do modelo de incorporação a ser usado para vetorização. Yes
tipo enumeração O identificador de tipo, sempre 'model_id' para este tipo de fonte de vetorização.
Valores possíveis: model_id		 Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

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

AzureChatDataSourceType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Nome Tipo Descrição Obrigatório Predefinido
managed_identity_resource_id cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: user_assigned_managed_identity		 Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Nome Tipo Descrição Obrigatório Predefinido
palavra-passe cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: username_and_password		 Yes
nome de utilizador cadeia (de caracteres) Yes

AzureChatDataSourceVectorizationSource

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

Discriminador para AzureChatDataSourceVectorizationSource

Este 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 Predefinido
tipo objecto Yes

AzureChatDataSourceVectorizationSourceType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzida pelo serviço Azure OpenAI ao usar o comportamento de extensão. Isso inclui informações de intenção e citação do recurso Em seus dados.

Nome Tipo Descrição Obrigatório Predefinido
all_retrieved_documents objecto Informações resumidas sobre documentos recuperados pela operação de recuperação de dados. Não
└─ chunk_id cadeia (de caracteres) O ID do bloco para a citação. Não
└─ conteúdo cadeia (de caracteres) O conteúdo da citação. Não
└─ índice_de_fonte_de_dados número inteiro O índice da fonte de dados usada para recuperação. Não
└─ caminho do arquivo cadeia (de caracteres) O caminho do arquivo para a citação. Não
└─ motivo_do_filtro enumeração Se aplicável, indicação do motivo pelo qual o documento foi filtrado.
Valores possíveis: score, rerank		 Não
└─ pontuação_original_de_pesquisa número A pontuação de pesquisa original para a recuperação. Não
└─ pontuação_reclassificação número A pontuação de reclassificação para a recuperação. Não
└─ consultas_de_pesquisa matriz As consultas de pesquisa executadas para recuperar documentos. Não
└─ título cadeia (de caracteres) O título da citação. Não
└─ URL cadeia (de caracteres) O URL da citação. Não
Citações matriz As citações produzidas pela recuperação de dados. Não
intenção cadeia (de caracteres) A intenção detetada do histórico de bate-papo, que é usado para transportar o contexto da conversa entre as interações Não

AzureContentFilterBlocklistResult

Uma coleção de resultados de filtragem verdadeiros/falsos para listas de bloqueio personalizadas configuradas.

Nome Tipo Descrição Obrigatório Predefinido
details matriz Os pares de IDs individuais da lista de bloqueio e se eles resultaram em uma ação de filtragem. Não
filtrado Booleano Um valor que indica se alguma das listas de bloqueio detalhadas resultou em uma ação de filtragem. Yes

AzureContentFilterCompletionTextSpan

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

Nome Tipo Descrição Obrigatório Predefinido
completion_end_offset número inteiro Deslocamento do primeiro ponto de código UTF32 que é excluído da extensão. Este campo é sempre igual a completion_start_offset para vãos vazios. Este campo é sempre maior do que completion_start_offset para vãos não vazios. Yes
completion_start_offset número inteiro Deslocamento do ponto de código UTF32 que inicia a extensão. Yes

AzureContentFilterCompletionTextSpanDetectionResult

Nome Tipo Descrição Obrigatório Predefinido
details matriz Informações detalhadas sobre as extensões de texto de conclusão detetadas. Yes
detetada Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Yes
filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes

AzureContentFilterCustomTopicResult

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

Nome Tipo Descrição Obrigatório Predefinido
details matriz Os pares de IDs de tópico individuais e se eles são detetados. Não
filtrado Booleano 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 detetado e se o conteúdo foi filtrado.

Nome Tipo Descrição Obrigatório Predefinido
detetada Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Yes
filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes

AzureContentFilterPersonallyIdentifiableInformationResult

Um resultado de deteção de filtro de conteúdo para Informações Pessoalmente Identificáveis que inclui extensões de danos.

Nome Tipo Descrição Obrigatório Predefinido
redacted_text cadeia (de caracteres) O texto editado com informações de PII removidas ou mascaradas. Não
sub_categories matriz Resultados detalhados para cada subcategoria(s) PIIHarm. 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 Predefinido
custom_blocklists objecto Uma coleção de resultados de filtragem verdadeiros/falsos para listas de bloqueio personalizadas configuradas. Não
└─ detalhes matriz Os pares de IDs individuais da lista de bloqueio e se eles resultaram em uma ação de filtragem. Não
└─ filtrado Booleano Um valor que indica se alguma das listas de bloqueio detalhadas resultou em uma ação de filtragem. Não
custom_topics objecto Uma coleção de resultados de filtragem verdadeiros/falsos para tópicos personalizados configurados. Não
└─ detalhes matriz Os pares de IDs de tópico individuais e se eles são detetados. Não
└─ filtrado Booleano Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. Não
erro objecto Se presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação. Não
└─ código número inteiro Um código distinto, legível por máquina, associado ao erro. Não
└─ mensagem cadeia (de caracteres) Uma mensagem legível por humanos associada ao erro. Não
ódio objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
personally_identifiable_information objecto Um resultado de deteção de filtro de conteúdo para Informações Pessoalmente Identificáveis que inclui extensões de danos. Não
└─ redacted_text cadeia (de caracteres) O texto editado com informações de PII removidas ou mascaradas. Não
└─ sub_categorias matriz Resultados detalhados para cada subcategoria(s) PIIHarm. Não
palavrões objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se o conteúdo foi
filtrado.		 Não
└─ Detetado Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Não
└─ filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Não
protected_material_code objecto Um resultado de deteção que descreve uma correspondência com o código licenciado ou outro material de origem protegido. Não
└─ citação objecto Se disponível, os detalhes da citação descrevendo a licença associada e sua localização. Não
└─ URL cadeia (de caracteres) O URL associado à licença. Não
└─ licença cadeia (de caracteres) O nome ou identificador da licença associada à deteção. Não
└─ Detetado Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Não
└─ filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Não
protected_material_text objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se o conteúdo foi
filtrado.		 Não
└─ Detetado Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Não
└─ filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Não
self_harm objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
sexual objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult Não
violência objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não

AzureContentFilterResultForPrompt

Um resultado de filtro de conteúdo associado a um único item de prompt de entrada em um sistema de IA generativa.

Nome Tipo Descrição Obrigatório Predefinido
content_filter_results objecto A categoria de filtro de conteúdo detalha o resultado. Não
└─ listas_de_bloqueio_personalizadas objecto Uma coleção de resultados de filtragem verdadeiros/falsos para listas de bloqueio personalizadas configuradas. Não
└─ detalhes matriz Os pares de IDs individuais da lista de bloqueio e se eles resultaram em uma ação de filtragem. Não
└─ filtrado Booleano Um valor que indica se alguma das listas de bloqueio detalhadas resultou em uma ação de filtragem. Não
└─ temas_personalizados objecto Uma coleção de resultados de filtragem verdadeiros/falsos para tópicos personalizados configurados. Não
└─ detalhes matriz Os pares de IDs de tópico individuais e se eles são detetados. Não
└─ filtrado Booleano Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. Não
└─ erro objecto Se presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação. Não
└─ código número inteiro Um código distinto, legível por máquina, associado ao erro. Não
└─ mensagem cadeia (de caracteres) Uma mensagem legível por humanos associada ao erro. Não
└─ ódio objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
└─ ataque indireto objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se o conteúdo foi
filtrado.		 Não
└─ Detetado Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Não
└─ filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ Jailbreak objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se o conteúdo foi
filtrado.		 Não
└─ Detetado Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Não
└─ filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ palavrões objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se o conteúdo foi
filtrado.		 Não
└─ Detetado Booleano Se a categoria de conteúdo rotulada foi detetada no conteúdo. Não
└─ filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ autolesão objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
└─ sexual objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
└─ violência objecto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual a
o nível de severidade do conteúdo foi, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria.		 Não
└─ filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Não
└─ gravidade enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Não
prompt_index número inteiro O índice do prompt de entrada associado às categorias de resultados do filtro de conteúdo que o 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 Predefinido
filtrado Booleano Se a severidade do conteúdo resultou em uma ação de filtragem de conteúdo. Yes
severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Yes

AzureCosmosDBChatDataSource

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

Nome Tipo Descrição Obrigatório Predefinido
parâmetros objecto As informações de parâmetro para controlar o uso da fonte de dados do Azure CosmosDB. Yes
└─ permitir_resultado_parcial Booleano Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todos os
as consultas parciais falham. Se não for especificado ou especificado como false, a solicitação falhará se qualquer consulta de pesquisa falhar.		 Não Falso
└─ autenticação AzureChatDataSourceConnectionStringAuthenticationOptions Não
└─ nome_do_container cadeia (de caracteres) Não
└─ nome_da_base_de_dados cadeia (de caracteres) Não
└─ dependência_de_incorporação AzureChatDataSourceVectorizationSource Uma representação de uma fonte de vetorização de dados utilizável como um recurso de incorporação com uma fonte de dados. Não
└─ mapeamento de campos objecto Não
└─ campos_de_conteúdo matriz Não
└─ separador_de_campos_de_conteúdo cadeia (de caracteres) Não
└─ campo_caminho_ficheiro cadeia (de caracteres) Não
└─ campo_título cadeia (de caracteres) Não
└─ campo_URL cadeia (de caracteres) Não
└─ vetor_fields matriz Não
└─ in_scope Booleano 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, serão solicitadas citações e intenção.		 Não ['citações', 'intenção']
└─ nome_do_índice cadeia (de caracteres) Não
└─ consultas_de_pesquisa_máximas número 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
└─ rigor número inteiro O rigor configurado da filtragem de relevância da pesquisa.
Um maior rigor aumentará a precisão, mas menor recordação da resposta.		 Não
└─ top_n_documents número 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ão de chat no serviço Azure OpenAI. Isso adiciona a capacidade de fornecer fontes de dados para o recurso Em seus dados.

Nome Tipo Descrição Obrigatório Predefinido
áudio objecto 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 de áudio de saída. Deve ser um dos wav, mp3, flac,
opus, ou pcm16.
Valores possíveis: wav, aac, mp3, flac, , opus, pcm16		 Não
└─ voz objecto Não
data_sources matriz As fontes de dados a serem usadas para o recurso On Your Data, exclusivo do Azure OpenAI. Não
penalização de frequência 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
probabilidade de repetir literalmente a mesma linha.		 Não 0
function_call enumeração Especificar uma função específica através {"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 objecto Modifique a probabilidade de tokens especificados aparecerem na conclusão.

Aceita um objeto JSON que mapeia tokens (especificado por sua ID de token na
tokenizer) para um valor de viés associado de -100 a 100. Matematicamente,
O viés é adicionado aos logits gerados pelo modelo antes da amostragem.
O efeito exato varia de acordo com o modelo, mas os valores entre -1 e 1 devem
diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100
deve resultar numa proibição ou seleção exclusiva do token relevante.		 Não Nenhum
Logprobs Booleano Se deve retornar as probabilidades de log dos tokens de saída ou não. Se for verdade,
retorna as probabilidades de log de cada token de saída retornado no
content de message.		 Não Falso
max_completion_tokens número inteiro Um limite superior para o número de tokens que podem ser gerados para um
conclusão, incluindo tokens de saída visíveis e tokens de raciocínio.		 Não
máximo de tokens número inteiro O número máximo de tokens que podem ser gerados na conclusão do chat.
Esse valor pode ser usado para controlar os custos do texto gerado via API.

Este valor é agora 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 compõem a conversa até agora. Dependendo do
modelo que você usa, diferentes tipos de mensagem (modalidades) são suportados,
como texto, imagens e áudio.		 Yes
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
Modalidades objecto Tipos de saída que você gostaria que o modelo gerasse.
A maioria dos modelos são capazes de gerar texto, que é o padrão:

["text"]

O gpt-4o-audio-preview modelo também pode ser usado para gerar áudio. Para solicitar que este modelo gere
Respostas de texto e áudio, você pode usar:

["text", "audio"]		 Não
modelo cadeia (de caracteres) O identificador de implantação do modelo a ser usado para a solicitação de conclusão do chat. Yes
n número inteiro Quantas opções de conclusão de chat gerar para cada mensagem de entrada. Observe que você será cobrado com base no número de tokens gerados em todas as opções. Manter n como 1 minimizar custos. Não 1
chamadas_de_ferramentas_em_paralelo objecto Se a chamada de função paralela deve ser ativada durante o uso da ferramenta. Não
predição objecto Representação de base da saída prevista de um modelo. Não
└─ tipo OpenAI.ChatOutputPredictionType Não
penalização por 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 temas.		 Não 0
esforço de raciocínio objecto apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
formato_de_resposta objecto Não
└─ tipo enumeração
Valores possíveis: text, json_object, json_schema		 Não
sementes número inteiro Este recurso está em versão Beta.
Se especificado, nosso sistema fará um melhor esforço para amostragem determinística, de modo que solicitações repetidas com os mesmos seed parâmetros e devem retornar o mesmo resultado.
O determinismo não é garantido e você deve consultar o system_fingerprint parâmetro response para monitorar as alterações no back-end.		 Não
pare objecto Não suportado com os modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências onde a API deixará de gerar mais tokens. O
O texto retornado não conterá a sequência de parada.		 Não
armazenar Booleano Armazenar ou não a saída desta solicitação de conclusão de bate-papo para
utilização em modelos de destilação ou em produtos evals.		 Não Falso
fluxo Booleano Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente
como é gerado usando eventos enviados pelo servidor.		 Não Falso
stream_options objecto Opções para resposta de streaming. Defina isso apenas quando definir stream: true. Não
└─ include_usage Booleano Se definido, um bloco adicional será transmitido antes do data: [DONE]
Mensagem. O usage campo neste bloco mostra as estatísticas de uso de token
para todo o pedido, e o choices campo será sempre um vazio
matriz.

Todas as outras partes também incluirão um usage campo, mas com um nulo
valor. OBSERVAÇÃO: Se o fluxo for interrompido, você pode não receber o
bloco de uso final que contém o uso total de token para a solicitação.		 Não
temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual (se houver) ferramenta é chamada pelo modelo.
none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.
required significa que o modelo deve chamar uma ou mais ferramentas.
Especificar uma ferramenta específica via {"type": "function", "function": {"name": "my_function"}} força o modelo a chamar essa ferramenta.

none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.		 Não
Ferramentas matriz Uma lista de ferramentas que o modelo pode chamar. Atualmente, apenas funções são suportadas como ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. Um máximo de 128 funções são suportadas. Não
top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não 1
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a
monitorizar e detetar 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 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 for Cloud. Não

AzureCreateChatCompletionResponse

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

Nome Tipo Descrição Obrigatório Predefinido
escolhas matriz Yes
criado número inteiro O carimbo de data/hora Unix (em segundos) de quando a conclusão do chat foi criada. Yes
id cadeia (de caracteres) Um identificador exclusivo para a conclusão do chat. Yes
modelo cadeia (de caracteres) O modelo usado para a conclusão do chat. Yes
objecto 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 da IA Responsável associadas a entradas de prompt na conclusão do bate-papo. Não
system_fingerprint cadeia (de caracteres) Essa impressão digital representa a configuração de back-end com a qual o modelo é executado.

Pode ser usado em conjunto com o parâmetro request para entender quando alterações de back-end foram feitas que podem afetar o seed determinismo.		 Não
utilização OpenAI.CompletionUsage Estatísticas de utilização do pedido de conclusão. Não

AzureCreateChatCompletionStreamResponse

Nome Tipo Descrição Obrigatório Predefinido
escolhas 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 seringa
ú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 número inteiro O carimbo de data/hora Unix (em segundos) de quando a conclusão do chat foi criada. Cada bloco 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 Azure OpenAI.
Este modelo adiciona suporte para o contexto de mensagens de chat, usado pelo recurso Em seus dados para intenção, citações e outros
informações relacionadas com a geração aumentada de recuperação realizada.		 Não
id cadeia (de caracteres) Um identificador exclusivo para a conclusão do chat. Cada pedaço tem o mesmo ID. Yes
modelo cadeia (de caracteres) O modelo para gerar a conclusão. Yes
objecto enumeração O tipo de objeto, que é sempre chat.completion.chunk.
Valores possíveis: chat.completion.chunk		 Yes
system_fingerprint cadeia (de caracteres) Essa impressão digital representa a configuração de back-end com a qual o modelo é executado.
Pode ser usado em conjunto com o parâmetro request para entender quando alterações de back-end foram feitas que podem afetar o seed determinismo.		 Não
utilização objecto Estatísticas de utilização do pedido de conclusão. Não
└─ tokens de conclusão número inteiro Número de tokens na conclusão gerada. Não 0
└─ detalhes_dos_tokens_de_conclusão objecto Detalhamento dos tokens usados em uma conclusão. Não
└─ tokens_de_previsão_aceites número inteiro Ao usar saídas previstas, o número de tokens na
previsão que apareceu na conclusão.		 Não 0
└─ fichas_de_áudio número inteiro Tokens de entrada de áudio gerados pelo modelo. Não 0
└─ tokens de raciocínio número inteiro Tokens gerados pelo modelo para raciocínio. Não 0
└─ tokens_de_previsão_rejeitados número inteiro Ao usar saídas previstas, o número de tokens na
previsão que não apareceu na conclusão. No entanto, como
Tokens de raciocínio, esses tokens ainda são contados no total
Tokens de conclusão para fins de faturamento, saída e janela de contexto
limites.		 Não 0
└─ prompt_tokens número inteiro Número de tokens no prompt. Não 0
└─ detalhes_das_fichas_de_prompt objecto Detalhamento dos tokens usados no prompt. Não
└─ fichas_de_áudio número inteiro Tokens de entrada de áudio presentes no prompt. Não 0
└─ tokens em cache número inteiro Tokens armazenados em cache presentes no prompt. Não 0
└─ fichas_totais número inteiro Número total de tokens usados na solicitação (prompt + conclusão). Não 0

AzureCreateEmbeddingRequest

Nome Tipo Descrição Obrigatório Predefinido
Dimensões número inteiro O número de dimensões que as incorporações de saída resultantes devem ter. Apenas suportado em text-embedding-3 modelos e modelos posteriores. Não
encoding_format enumeração O formato para retornar as incorporações. Pode ser qualquer um float ou base64.
Valores possíveis: float, base64		 Não
dados introduzidos cadeia de caracteres ou matriz Yes
modelo cadeia (de caracteres) O modelo a ser usado para a solicitação de incorporação. Yes
utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Não

AzureCreateFileRequestMultiPart

Nome Tipo Descrição Obrigatório Predefinido
expira após objecto Yes
└─ âncora AzureFileExpiryAnchor Não
└─ segundos número inteiro Não
ficheiro cadeia (de caracteres) Yes
Finalidade enumeração A finalidade pretendida do ficheiro carregado. Um dos seguintes: - assistants: Usado na API de assistentes - batch: Usado na API de lote - fine-tune: Usado para ajuste fino - evals: Usado para conjuntos de dados eval
Valores possíveis: assistants, batch, fine-tune, evals		 Yes

AzureCreateResponse

Nome Tipo Descrição Obrigatório Predefinido
em segundo plano Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
include matriz Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Atualmente
Os valores suportados são:
- code_interpreter_call.outputs: Inclui as saídas de execução de código python
na ferramenta interpretador de código, chamar itens.
- computer_call_output.output.image_url: Inclua urls de imagem da saída de chamada do computador.
- file_search_call.results: Incluir os resultados da pesquisa de
a chamada da ferramenta de pesquisa de ficheiros.
- 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 encriptada do raciocínio
tokens em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em
conversas com vários turnos ao usar a API de respostas sem estado (como
quando o store parâmetro é definido como false, ou quando uma organização é
inscritos no programa de retenção de dados zero).		 Não
dados introduzidos cadeia de caracteres ou matriz Não
instructions cadeia (de caracteres) Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
max_output_tokens número 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 número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
modelo cadeia (de caracteres) A implantação do modelo a ser usado para a criação dessa resposta. Yes
chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
previous_response_id cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
avisar objecto Referência a um modelo de prompt e suas variáveis.
 Não
└─ ID cadeia (de caracteres) O identificador exclusivo do modelo de prompt a ser usado. Não
└─ variáveis OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis em seu
prompt. Os valores de substituição podem ser strings ou outros
Tipos de entrada de resposta, como imagens ou arquivos.		 Não
└─ versão cadeia (de caracteres) Versão opcional do modelo de prompt. Não
Fundamentação objecto apenas modelos de raciocínio

Opções de configuração para
modelos de raciocínio.		 Não
└─ esforço OpenAI.ReasoningEffort apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
└─ gerar_resumo enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
└─ Resumo enumeração Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
armazenar Booleano Se a resposta do modelo gerado deve ser armazenada para recuperação posterior via
API.		 Não Verdade
fluxo Booleano Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente
como é gerado usando eventos enviados pelo servidor.
Veja a seção Streaming abaixo
para mais informações.		 Não Falso
temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não 1
enviar SMS objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto ou dados JSON estruturados. Saiba mais: Saídas estruturadas		 Não
└─ formato OpenAI.ResponseTextFormatConfiguration Não
tool_choice objecto Controla qual (se houver) ferramenta é 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa de arquivos.
- Chamadas de função (ferramentas personalizadas): funções que são definidas por você,
permitindo que o modelo chame seu próprio código.		 Não
top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não 1
truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Não

AzureErrorResponse

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

AzureEvalAPICompletionsSamplingParams

Nome Tipo Descrição Obrigatório Predefinido
chamadas_de_ferramentas_em_paralelo Booleano Não
formato_de_resposta OpenAI.ResponseTextFormatConfiguration Não
Ferramentas matriz Não

AzureEvalAPIModelSamplingParams

Nome Tipo Descrição Obrigatório Predefinido
máximo de tokens número 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, medium, high		 Não
sementes número inteiro Um valor de semente 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 a amostragem do núcleo; 1.0 inclui todos os tokens. Não

AzureEvalAPIResponseSamplingParams

Nome Tipo Descrição Obrigatório Predefinido
chamadas_de_ferramentas_em_paralelo Booleano Não
formato_de_resposta OpenAI.ResponseTextFormatConfiguration Não
Ferramentas matriz Não

AzureFileExpiryAnchor

Propriedade Valor
Tipo cadeia (de caracteres)
Valores created_at

AzureFineTuneReinforcementMethod

Nome Tipo Descrição Obrigatório Predefinido
Motoniveladora objecto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calcular_saída cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Não
└─ métrica_de_avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Não
└─ Motoniveladoras objecto Não
└─ entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Não
└─ modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Não
└─ nome cadeia (de caracteres) O nome do classificador. Não
└─ operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Não
└─ gama matriz O intervalo da pontuação. O padrão é [0, 1]. Não
└─ referência cadeia (de caracteres) O texto que está a ser avaliado. Não
└─ parâmetros_de_amostragem Os parâmetros de amostragem para o 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 utilizados para o trabalho de ajuste fino de reforço. Não
formato_de_resposta objecto Não
└─ json_schema objecto 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 Predefinido
dados matriz Yes
first_id cadeia (de caracteres) Yes
tem_mais Booleano Yes
last_id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: list		 Yes

AzureOpenAIFile

Nome Tipo Descrição Obrigatório Predefinido
bytes número inteiro O tamanho do arquivo, em bytes. Yes
criado_em número inteiro O carimbo de data/hora do Unix (em segundos) para quando o arquivo foi criado. Yes
expira_em número inteiro O carimbo de data/hora do Unix (em segundos) para quando o arquivo expirará. Não
nome do ficheiro cadeia (de caracteres) O nome do arquivo. Yes
id cadeia (de caracteres) O identificador de arquivo, que pode ser referenciado nos pontos de extremidade da API. Yes
objecto enumeração O tipo de objeto, que é sempre file.
Valores possíveis: file		 Yes
Finalidade enumeração A finalidade pretendida do ficheiro. Os valores suportados são assistants, assistants_output, batch, batch_outputfine-tunee fine-tune-results.
Valores possíveis: , , , , , assistantsassistants_output, , batchbatch_outputfine-tunefine-tune-resultsevals		 Yes
estado enumeração
Valores possíveis: , , , , , uploadedpending, , runningprocessederrordeletingdeleted		 Yes
detalhes_do_status cadeia (de caracteres) 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 cada PIIHarmSubCategory(s).

Nome Tipo Descrição Obrigatório Predefinido
detetada Booleano Se a subcategoria de conteúdo rotulado foi detetada no conteúdo. Yes
filtrado Booleano Se a deteção de conteúdo resultou em uma ação de filtragem de conteúdo para essa subcategoria. Yes
editado Booleano Se o conteúdo foi editado para esta subcategoria. Yes
sub_category cadeia (de caracteres) A Subcategoria PIIHarmque foi avaliada. Yes

AzureResponse

Nome Tipo Descrição Obrigatório Predefinido
em segundo plano Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
criado_em número inteiro Carimbo de data/hora Unix (em segundos) de quando esta resposta foi criada. Yes
erro objecto Um objeto de erro retornado quando o modelo não consegue gerar uma resposta. Yes
└─ código OpenAI.ResponseErrorCode O código de erro para a resposta. Não
└─ mensagem cadeia (de caracteres) Uma descrição do erro legível por humanos. Não
id cadeia (de caracteres) Identificador exclusivo para esta resposta. Yes
incomplete_details objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Yes
└─ Justificação enumeração A razão pela 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 número 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 número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
modelo cadeia (de caracteres) O modelo usado para gerar essa resposta. Yes
objecto enumeração O tipo de objeto deste recurso - sempre definido como response.
Valores possíveis: response		 Yes
output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Yes
output_text cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Yes Verdade
previous_response_id cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
avisar objecto Referência a um modelo de prompt e suas variáveis.
 Não
└─ ID cadeia (de caracteres) O identificador exclusivo do modelo de prompt a ser usado. Não
└─ variáveis OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis em seu
prompt. Os valores de substituição podem ser strings ou outros
Tipos de entrada de resposta, como imagens ou arquivos.		 Não
└─ versão cadeia (de caracteres) Versão opcional do modelo de prompt. Não
Fundamentação objecto apenas modelos de raciocínio

Opções de configuração para
modelos de raciocínio.		 Não
└─ esforço OpenAI.ReasoningEffort apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
└─ gerar_resumo enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
└─ Resumo enumeração Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
estado enumeração O status da geração de resposta. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Yes
enviar SMS objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto ou dados JSON estruturados. Saiba mais: Saídas estruturadas		 Não
└─ formato OpenAI.ResponseTextFormatConfiguration Não
tool_choice objecto Controla qual (se houver) ferramenta é 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Yes
truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Yes

AzureSearchChatDataSource

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

Nome Tipo Descrição Obrigatório Predefinido
parâmetros objecto As informações de parâmetro para controlar o uso da fonte de dados do Azure Search. Yes
└─ permitir_resultado_parcial Booleano Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todos os
as consultas parciais falham. Se não for especificado ou especificado como false, a solicitação falhará se qualquer consulta de pesquisa falhar.		 Não Falso
└─ autenticação objecto Não
└─ token_de_acesso cadeia (de caracteres) Não
└─ chave cadeia (de caracteres) Não
└─ ID_recurso_identidade_gerida cadeia (de caracteres) Não
└─ tipo enumeração
Valores possíveis: access_token		 Não
└─ dependência_de_incorporação objecto Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de incorporação do Azure OpenAI. Não
└─ autenticação AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions O mecanismo de autenticação a ser usado com a fonte de vetorização baseada em ponto de extremidade.
A autenticação de ponto de extremidade suporta mecanismos de chave de API e token de acesso.		 Não
└─ nome_da_implantação cadeia (de caracteres) A implantação do modelo de incorporação a ser usado para vetorização. Essa implantação deve existir dentro do mesmo Azure OpenAI
como a implantação do modelo que está sendo usado para a conclusão do chat.		 Não
└─ Dimensões número inteiro O número de dimensões a solicitar nas incorporações.
Suportado apenas em 'text-embedding-3' e modelos posteriores.		 Não
└─ Ponto final cadeia (de caracteres) Especifica a URL do ponto de extremidade do recurso a partir da qual as incorporações devem ser recuperadas.
Deve ter o 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 'integrado' para este tipo de fonte de vetorização.
Valores possíveis: integrated		 Não
└─ Ponto final cadeia (de caracteres) O caminho de ponto de extremidade absoluto para o recurso de Pesquisa do Azure a ser usado. Não
└─ mapeamento de campos objecto Os mapeamentos de campo a serem usados com o recurso Pesquisa do Azure. Não
└─ campos_de_conteúdo matriz Os nomes dos campos de índice que devem ser tratados como conteúdo. Não
└─ separador_de_campos_de_conteúdo cadeia (de caracteres) O padrão separador que os campos de conteúdo devem usar. Não
└─ campo_caminho_ficheiro cadeia (de caracteres) O nome do campo de índice a ser usado como um caminho de arquivo. Não
└─ image_vetor_fields matriz Os nomes dos campos que representam dados vetoriais de imagem. Não
└─ campo_título cadeia (de caracteres) O nome do campo de índice a ser usado como título. Não
└─ campo_URL cadeia (de caracteres) O nome do campo de índice a ser usado como URL. Não
└─ vetor_fields matriz Os nomes dos campos que representam dados vetoriais. Não
└─ Filtrar cadeia (de caracteres) Um filtro para aplicar à pesquisa. Não
└─ in_scope Booleano 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, serão solicitadas citações e intenção.		 Não ['citações', 'intenção']
└─ nome_do_índice cadeia (de caracteres) O nome do índice a ser usado, conforme especificado no recurso Pesquisa do Azure. Não
└─ consultas_de_pesquisa_máximas número 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 de Pesquisa do Azure a ser usado.
Valores possíveis: simple, semantic, vector, vector_simple_hybrid, , vector_semantic_hybrid		 Não
└─ configuração_semântica cadeia (de caracteres) Configuração semântica adicional para a consulta. Não
└─ rigor número inteiro O rigor configurado da filtragem de relevância da pesquisa.
Um maior rigor aumentará a precisão, mas menor recordação da resposta.		 Não
└─ top_n_documents número 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 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 for Cloud.

Nome Tipo Descrição Obrigatório Predefinido
application_name cadeia (de caracteres) O nome do aplicativo. As informações pessoais sensíveis não devem ser incluídas neste campo. Não
end_user_id cadeia (de caracteres) Esse identificador é a ID do objeto de usuário do Microsoft Entra ID (anteriormente Azure Ative Directory) usada para autenticar usuários finais no aplicativo de IA generativa. As informações pessoais sensíveis não devem ser incluídas neste campo. Não
end_user_tenant_id cadeia (de caracteres) O ID de locatário do Microsoft 365 ao qual o usuário final pertence. É necessário quando o aplicativo de IA generativa é multilocatário. Não
source_ip cadeia (de caracteres) 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 Predefinido
destinationResourceId cadeia (de caracteres) A ID do recurso de destino para o qual o modelo foi copiado. Yes
região cadeia (de caracteres) A região para onde o modelo foi copiado. Yes
estado enumeração O status da operação de cópia.
Valores possíveis: Completed, Failed, InProgress		 Yes

CopyModelRequest

Nome Tipo Descrição Obrigatório Predefinido
destinationResourceId cadeia (de caracteres) A ID do Recurso de destino a ser copiado. Yes
região cadeia (de caracteres) A região para a qual copiar o modelo. Yes

CopyModelResponse

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

ElasticsearchChatDataSource

Nome Tipo Descrição Obrigatório Predefinido
parâmetros objecto As informações de parâmetro para controlar o uso da fonte de dados do Elasticsearch. Yes
└─ permitir_resultado_parcial Booleano Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todos os
as consultas parciais falham. Se não for especificado ou especificado como false, a solicitação falhará se qualquer consulta de pesquisa falhar.		 Não Falso
└─ autenticação objecto Não
└─ chave_api_codificada cadeia (de caracteres) Não
└─ chave cadeia (de caracteres) Não
└─ key_id cadeia (de caracteres) Não
└─ tipo enumeração
Valores possíveis: encoded_api_key		 Não
└─ dependência_de_incorporação AzureChatDataSourceVectorizationSource Uma representação de uma fonte de vetorização de dados utilizável como um recurso de incorporação com uma fonte de dados. Não
└─ Ponto final cadeia (de caracteres) Não
└─ mapeamento de campos objecto Não
└─ campos_de_conteúdo matriz Não
└─ separador_de_campos_de_conteúdo cadeia (de caracteres) Não
└─ campo_caminho_ficheiro cadeia (de caracteres) Não
└─ campo_título cadeia (de caracteres) Não
└─ campo_URL cadeia (de caracteres) Não
└─ vetor_fields matriz Não
└─ in_scope Booleano 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, serão solicitadas citações e intenção.		 Não ['citações', 'intenção']
└─ nome_do_índice cadeia (de caracteres) Não
└─ consultas_de_pesquisa_máximas número 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
└─ rigor número inteiro O rigor configurado da filtragem de relevância da pesquisa.
Um maior rigor aumentará a precisão, mas menor recordação da resposta.		 Não
└─ top_n_documents número 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 Predefinido
parâmetros objecto As informações de parâmetros para controlar o uso da fonte de dados MongoDB. Yes
└─ permitir_resultado_parcial Booleano Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todos os
as consultas parciais falham. Se não for especificado ou especificado como false, a solicitação falhará se qualquer consulta de pesquisa falhar.		 Não Falso
└─ nome_da_aplicação cadeia (de caracteres) O nome do aplicativo MongoDB. Não
└─ autenticação objecto Não
└─ palavra-passe cadeia (de caracteres) Não
└─ tipo enumeração
Valores possíveis: username_and_password		 Não
└─ nome de utilizador cadeia (de caracteres) Não
└─ nome_da_colecção cadeia (de caracteres) O nome da coleção MongoDB. Não
└─ nome_da_base_de_dados cadeia (de caracteres) O nome do banco de dados MongoDB. Não
└─ dependência_de_incorporação objecto Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de incorporação do Azure OpenAI. Não
└─ autenticação AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions O mecanismo de autenticação a ser usado com a fonte de vetorização baseada em ponto de extremidade.
A autenticação de ponto de extremidade suporta mecanismos de chave de API e token de acesso.		 Não
└─ nome_da_implantação cadeia (de caracteres) A implantação do modelo de incorporação a ser usado para vetorização. Essa implantação deve existir dentro do mesmo Azure OpenAI
como a implantação do modelo que está sendo usado para a conclusão do chat.		 Não
└─ Dimensões número inteiro O número de dimensões a solicitar nas incorporações.
Suportado apenas em 'text-embedding-3' e modelos posteriores.		 Não
└─ Ponto final cadeia (de caracteres) Especifica a URL do ponto de extremidade do recurso a partir da qual as incorporações devem ser recuperadas.
Deve ter o 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 fonte de vetorização.
Valores possíveis: deployment_name		 Não
└─ Ponto final cadeia (de caracteres) O nome do ponto de extremidade do cluster MongoDB. Não
└─ mapeamento de campos objecto Mapeamentos de campo a serem aplicados aos dados usados pela fonte de dados MongoDB.
Observe que os mapeamentos de conteúdo e campo vetorial são necessários para o MongoDB.		 Não
└─ campos_de_conteúdo matriz Não
└─ separador_de_campos_de_conteúdo cadeia (de caracteres) Não
└─ campo_caminho_ficheiro cadeia (de caracteres) Não
└─ campo_título cadeia (de caracteres) Não
└─ campo_URL cadeia (de caracteres) Não
└─ vetor_fields matriz Não
└─ in_scope Booleano 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, serão solicitadas citações e intenção.		 Não ['citações', 'intenção']
└─ nome_do_índice cadeia (de caracteres) O nome do índice MongoDB. Não
└─ consultas_de_pesquisa_máximas número 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
└─ rigor número inteiro O rigor configurado da filtragem de relevância da pesquisa.
Um maior rigor aumentará a precisão, mas menor recordação da resposta.		 Não
└─ top_n_documents número 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.Anotação

Discriminador para OpenAI.Annotation

Este 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 Predefinido
tipo OpenAI.AnnotationType Yes

OpenAI.AnnotationFileCitation

Uma citação a um ficheiro.

Nome Tipo Descrição Obrigatório Predefinido
identificação_de_ficheiro cadeia (de caracteres) A ID do arquivo. Yes
nome do ficheiro cadeia (de caracteres) O nome do arquivo citado. Yes
indexar número inteiro O índice do arquivo na lista de arquivos. Yes
tipo enumeração O tipo de citação do arquivo. Sempre file_citation.
Valores possíveis: file_citation		 Yes

OpenAI.AnnotationFilePath

Um caminho para um arquivo.

Nome Tipo Descrição Obrigatório Predefinido
identificação_de_ficheiro cadeia (de caracteres) A ID do arquivo. Yes
indexar número 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 (de caracteres)
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 Predefinido
end_index número inteiro O índice do último caractere da citação de URL na mensagem. Yes
start_index número inteiro O índice do primeiro caractere da citação de URL na mensagem. Yes
title cadeia (de caracteres) O título do recurso Web. Yes
tipo enumeração O tipo de citação de URL. Sempre url_citation.
Valores possíveis: url_citation		 Yes
URL cadeia (de caracteres) O URL do recurso Web. Yes

OpenAI.ApproximateLocation

Nome Tipo Descrição Obrigatório Predefinido
cidade cadeia (de caracteres) Não
país cadeia (de caracteres) Não
região cadeia (de caracteres) Não
Fuso horário cadeia (de caracteres) Não
tipo enumeração
Valores possíveis: approximate		 Yes

OpenAI.AutoChunkingStrategyRequestParam

A estratégia padrão. Esta estratégia utiliza atualmente um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400.

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

OpenAI.ChatCompletionFunctionCallOption

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

Nome Tipo Descrição Obrigatório Predefinido
nome cadeia (de caracteres) O nome da função a ser chamada. Yes

OpenAI.ChatCompletionFunctions

Nome Tipo Descrição Obrigatório Predefinido
descrição cadeia (de caracteres) 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 (de caracteres) 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 que as funções aceitam, descritos como um objeto de esquema JSON.
Consulte a referência do esquema JSON
para documentação sobre o formato.

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

OpenAI.ChatCompletionMessageAudioChunk

Nome Tipo Descrição Obrigatório Predefinido
dados cadeia (de caracteres) Não
expira_em número inteiro Não
id cadeia (de caracteres) Não
transcrição cadeia (de caracteres) Não

OpenAI.ChatCompletionMessageToolCall

Nome Tipo Descrição Obrigatório Predefinido
função objecto A função que o modelo chamou. Yes
└─ argumentos cadeia (de caracteres) Os argumentos com os quais chamar a função, conforme gerado pelo modelo no formato JSON. Observe que o modelo nem sempre gera JSON válido e pode alucinar parâmetros não definidos pelo seu esquema de função. Valide os argumentos em seu código antes de chamar sua função. Não
└─ nome cadeia (de caracteres) O nome da função a ser chamada. Não
id cadeia (de caracteres) O identificador da chamada da ferramenta. Yes
tipo enumeração O tipo da ferramenta. Atualmente, apenas function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Nome Tipo Descrição Obrigatório Predefinido
função objecto Não
└─ argumentos cadeia (de caracteres) Os argumentos com os quais chamar a função, conforme gerado pelo modelo no formato JSON. Observe que o modelo nem sempre gera JSON válido e pode alucinar parâmetros não definidos pelo seu esquema de função. Valide os argumentos em seu código antes de chamar sua função. Não
└─ nome cadeia (de caracteres) O nome da função a ser chamada. Não
id cadeia (de caracteres) O identificador da chamada da ferramenta. Não
indexar número inteiro Yes
tipo enumeração O tipo da ferramenta. Atualmente, apenas function é suportado.
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 Predefinido
função objecto Yes
└─ nome cadeia (de caracteres) O nome da função a ser chamada. Não
tipo enumeração O tipo da ferramenta. Atualmente, apenas function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionRequestAssistantMessage

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

Nome Tipo Descrição Obrigatório Predefinido
áudio objecto Dados sobre uma resposta de áudio anterior do modelo. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para uma resposta de áudio anterior do modelo. Não
conteúdo cadeia de caracteres ou matriz Não
function_call objecto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. Não
└─ argumentos cadeia (de caracteres) Não
└─ nome cadeia (de caracteres) Não
nome cadeia (de caracteres) Um nome opcional para o participante. Fornece as informações do modelo para diferenciar entre participantes da mesma função. Não
recusa cadeia (de caracteres) A mensagem de recusa por parte do assistente. Não
função enumeração O papel do autor das mensagens, neste 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 Predefinido
recusa cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. Yes
enviar SMS cadeia (de caracteres) 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. Com modelos o1 e mais recentes, developer as mensagens substituem as mensagens anteriores system .

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

OpenAI.ChatCompletionRequestFunctionMessage

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

OpenAI.ChatCompletionRequestMessage

Discriminador para OpenAI.ChatCompletionRequestMessage

Este 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 Predefinido
conteúdo cadeia de caracteres ou matriz Não
função objecto O papel do autor de uma mensagem Yes

OpenAI.ChatCompletionRequestMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestMessageContentPart

Este 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 Predefinido
tipo OpenAI.ChatCompletionRequestMessageContentPartType Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Nome Tipo Descrição Obrigatório Predefinido
input_audio objecto Yes
└─ dados cadeia (de caracteres) Dados de áudio codificados em Base64. Não
└─ formato enumeração O formato dos dados de áudio codificados. Atualmente suporta "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 Predefinido
ficheiro objecto Yes
└─ dados_de_ficheiro cadeia (de caracteres) Os dados do arquivo codificado base64, usados ao passar o arquivo para o modelo
como uma cadeia de caracteres.		 Não
└─ id_do_arquivo cadeia (de caracteres) A ID de um arquivo carregado para usar como entrada. Não
└─ nome do ficheiro cadeia (de caracteres) O nome do arquivo, usado ao passar o arquivo para o modelo como um
string.		 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 Predefinido
image_url objecto Yes
└─ detalhe enumeração Especifica o nível de detalhe da imagem.
Valores possíveis: auto, low, high		 Não
└─ URL cadeia (de caracteres) Um 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 Predefinido
recusa cadeia (de caracteres) 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 Predefinido
enviar SMS cadeia (de caracteres) 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 (de caracteres)
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 developer mensagens para este fim.

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referências: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Nome Tipo Descrição Obrigatório Predefinido
conteúdo cadeia de caracteres ou matriz Yes
função enumeração O papel do autor das mensagens, neste caso tool.
Valores possíveis: tool		 Yes
tool_call_id cadeia (de caracteres) 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 Predefinido
conteúdo cadeia de caracteres ou matriz Yes
nome cadeia (de caracteres) Um nome opcional para o participante. Fornece as informações do modelo para diferenciar entre participantes da mesma função. Não
função enumeração O papel do autor das mensagens, neste caso user.
Valores possíveis: user		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Nome Tipo Descrição Obrigatório Predefinido
ficheiro objecto Yes
└─ dados_de_ficheiro cadeia (de caracteres) Os dados do arquivo codificado base64, usados ao passar o arquivo para o modelo
como uma cadeia de caracteres.		 Não
└─ id_do_arquivo cadeia (de caracteres) A ID de um arquivo carregado para usar como entrada. Não
└─ nome do ficheiro cadeia (de caracteres) O nome do arquivo, usado ao passar o arquivo para o modelo como um
string.		 Não
image_url objecto Yes
└─ detalhe enumeração Especifica o nível de detalhe da imagem.
Valores possíveis: auto, low, high		 Não
└─ URL cadeia (de caracteres) Um URL da imagem ou os dados de imagem codificados em base64. Não
input_audio objecto Yes
└─ dados cadeia (de caracteres) Dados de áudio codificados em Base64. Não
└─ formato enumeração O formato dos dados de áudio codificados. Atualmente suporta "wav" e "mp3".
Valores possíveis: wav, mp3		 Não
enviar SMS cadeia (de caracteres) 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

O papel do autor de uma mensagem

Propriedade Valor
Descrição O papel do autor de uma mensagem
Tipo cadeia (de caracteres)
Valores system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

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

Nome Tipo Descrição Obrigatório Predefinido
include_usage Booleano Se definido, um bloco adicional será transmitido antes do data: [DONE]
Mensagem. O usage campo neste bloco mostra as estatísticas de uso de token
para todo o pedido, e o choices campo será sempre um vazio
matriz.

Todas as outras partes também incluirão um usage campo, mas com um nulo
valor. OBSERVAÇÃO: Se o fluxo for interrompido, você pode não receber o
bloco de uso final que contém o uso total de 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 Predefinido
áudio objecto Não
└─ dados cadeia (de caracteres) Não
└─ expira_em número inteiro Não
└─ ID cadeia (de caracteres) Não
└─ Transcrição cadeia (de caracteres) Não
conteúdo cadeia (de caracteres) O conteúdo da mensagem de bloco. Não
function_call objecto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. Não
└─ argumentos cadeia (de caracteres) Não
└─ nome cadeia (de caracteres) Não
recusa cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. Não
função objecto O papel do autor de uma mensagem Não
tool_calls matriz Não

OpenAI.ChatCompletionTokenLogprob

Nome Tipo Descrição Obrigatório Predefinido
bytes matriz Uma lista de inteiros que representam a representação de bytes UTF-8 do token. Útil em casos 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. Pode ser null se não houver representação de bytes para o token. Yes
Logprob número A probabilidade de log deste token, se estiver dentro dos 20 principais tokens mais prováveis. Caso contrário, o valor -9999.0 é usado para significar que o token é muito improvável. Yes
token cadeia (de caracteres) O token. Yes
top_logprobs matriz Lista dos tokens mais prováveis e sua probabilidade de log, nesta posição de token. Em casos raros, pode haver menos do que o número de pedidos top_logprobs devolvidos. Yes

FerramentaDeConcluãoDeChatDaOpenAI

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

OpenAI.ChatCompletionToolChoiceOption

Controla qual (se houver) ferramenta é chamada pelo modelo. none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem. auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas. required significa que o modelo deve chamar uma ou mais ferramentas. Especificar uma ferramenta específica via {"type": "function", "function": {"name": "my_function"}} força o modelo a chamar essa ferramenta.

none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.

Nome Tipo Descrição Obrigatório Predefinido
função objecto Yes
└─ nome cadeia (de caracteres) O nome da função a ser chamada. Não
tipo enumeração O tipo da ferramenta. Atualmente, apenas function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatOutputPrediction

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

Discriminador para OpenAI.ChatOutputPrediction

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

Valor do tipo Esquema
content OpenAI.ChatOutputPredictionContent
Nome Tipo Descrição Obrigatório Predefinido
tipo OpenAI.ChatOutputPredictionType Yes

OpenAI.ChatOutputPredictionContent

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

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

OpenAI.ChatOutputPredictionType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores content

OpenAI.ChunkingStrategyRequestParam

A estratégia de fragmentação usada para fragmentar o(s) arquivo(s). Se não estiver definido, usará a auto estratégia.

Discriminador para OpenAI.ChunkingStrategyRequestParam

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

Valor do tipo Esquema
static OpenAI.StaticChunkingStrategyRequestParam
Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo de estratégia de fragmentação.
Valores possíveis: auto, static		 Yes

OpenAI.ChunkingStrategyResponseParam

Discriminador para OpenAI.ChunkingStrategyResponseParam

Este 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 Predefinido
tipo enumeração
Valores possíveis: static, other		 Yes

OpenAI.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

Este 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 Predefinido
tipo OpenAI.CodeInterpreterOutputType Yes

OpenAI.CodeInterpreterOutputImage

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

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo de saída. Sempre 'imagem'.
Valores possíveis: image		 Yes
URL cadeia (de caracteres) 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 Predefinido
registos cadeia (de caracteres) A saída de logs do interpretador de código. Yes
tipo enumeração O tipo de saída. Sempre 'logs'.
Valores possíveis: logs		 Yes

OpenAI.CodeInterpreterOutputType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores logs
image

OpenAI.CodeInterpreterTool

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

Nome Tipo Descrição Obrigatório Predefinido
contentor objecto Configuração para um contêiner de interpretador de código. Opcionalmente, especifique os IDs
dos arquivos para executar o código neles.		 Yes
└─ identificadores_de_ficheiro matriz Uma lista opcional de arquivos carregados para disponibilizar para o 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 Predefinido
identificadores_de_arquivo matriz Uma lista opcional de arquivos carregados para disponibilizar para o seu código. Não
tipo enumeração Sempre auto.
Valores possíveis: auto		 Yes

OpenAI.CodeInterpreterToolCallItemParam

Uma chamada de ferramenta para executar código.

Nome Tipo Descrição Obrigatório Predefinido
código cadeia (de caracteres) O código a ser executado ou null se não estiver disponível. Yes
container_id cadeia (de caracteres) 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 código.

Nome Tipo Descrição Obrigatório Predefinido
código cadeia (de caracteres) O código a ser executado ou null se não estiver disponível. Yes
container_id cadeia (de caracteres) 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
estado enumeração
Valores possíveis: in_progress, completed, incomplete, interpreting, , failed		 Yes
tipo enumeração
Valores possíveis: code_interpreter_call		 Yes

OpenAI.ComparisonFilter

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 Predefinido
chave cadeia (de caracteres) A chave pela qual se compara o valor. Yes
tipo enumeração Especifica o operador de comparação: eq, ne, gt, gte, lt, lte.
- eq: igual a
- ne: não igual
- gt: superior a
- gte: maior ou igual
- lt: menos de
- lte: menor ou igual
Valores possíveis: eq, ne, gt, gte, , lt, lte		 Yes
valor string ou número ou booleano Yes

OpenAI.CompletionUsage

Estatísticas de utilização do pedido de conclusão.

Nome Tipo Descrição Obrigatório Predefinido
completion_tokens número inteiro Número de tokens na conclusão gerada. Yes 0
completion_tokens_details objecto Detalhamento dos tokens usados em uma conclusão. Não
└─ tokens_de_previsão_aceites número inteiro Ao usar saídas previstas, o número de tokens na
previsão que apareceu na conclusão.		 Não 0
└─ fichas_de_áudio número inteiro Tokens de entrada de áudio gerados pelo modelo. Não 0
└─ tokens de raciocínio número inteiro Tokens gerados pelo modelo para raciocínio. Não 0
└─ tokens_de_previsão_rejeitados número inteiro Ao usar saídas previstas, o número de tokens na
previsão que não apareceu na conclusão. No entanto, como
Tokens de raciocínio, esses tokens ainda são contados no total
Tokens de conclusão para fins de faturamento, saída e janela de contexto
limites.		 Não 0
prompt_tokens número inteiro Número de tokens no prompt. Yes 0
prompt_tokens_details objecto Detalhamento dos tokens usados no prompt. Não
└─ fichas_de_áudio número inteiro Tokens de entrada de áudio presentes no prompt. Não 0
└─ tokens em cache número inteiro Tokens armazenados em cache presentes no prompt. Não 0
total_tokens número inteiro Número total de tokens usados na solicitação (prompt + conclusão). Yes 0

OpenAI.CompoundFilter

Combine vários filtros usando and ou or.

Nome Tipo Descrição Obrigatório Predefinido
filtros matriz Matriz de filtros para combinar. 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

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

Valor do tipo Esquema
click OpenAI.ComputerActionClique
double_click OpenAI.ComputerActionDoubleClick
drag OpenAI.ComputerActionArrastar
move OpenAI.ComputerActionMove
screenshot OpenAI.ComputerActionScreenshot
scroll OpenAI.ComputerActionScroll
type OpenAI.ComputerActionTypeKeys
wait OpenAI.ComputerActionWait
keypress OpenAI.ComputerActionKeyPress
Nome Tipo Descrição Obrigatório Predefinido
tipo OpenAI.ComputerActionType Yes

OpenAI.ComputerActionClique

Uma ação de clique.

Nome Tipo Descrição Obrigatório Predefinido
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, esta propriedade é
sempre definido como click.
Valores possíveis: click		 Yes
x número inteiro A coordenada x onde ocorreu o clique. Yes
y número inteiro A coordenada y onde ocorreu o clique. Yes

OpenAI.ComputerActionDoubleClick

Uma ação de clique duplo.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração Especifica o tipo de evento. Para uma ação de clique duplo, esta propriedade é
sempre definido como double_click.
Valores possíveis: double_click		 Yes
x número inteiro A coordenada x onde ocorreu o duplo clique. Yes
y número inteiro A coordenada y onde ocorreu o duplo clique. Yes

OpenAI.ComputerActionArrastar

Uma ação de arrastar.

Nome Tipo Descrição Obrigatório Predefinido
caminho matriz Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas aparecerão 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, esta propriedade é
sempre definido 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 Predefinido
Teclas matriz A combinação de teclas que o modelo está solicitando para ser pressionada. 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 de pressionamento de teclas, esta propriedade é
sempre definido como keypress.
Valores possíveis: keypress		 Yes

OpenAI.ComputerActionMove

Uma ação de movimento do mouse.

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

OpenAI.ComputerActionScreenshot

Uma ação de captura de tela.

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

OpenAI.ComputerActionScroll

Uma ação de rolagem.

Nome Tipo Descrição Obrigatório Predefinido
scroll_x número inteiro A distância de rolagem horizontal. Yes
scroll_y número inteiro A distância de rolagem vertical. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de rolagem, esta propriedade é
sempre definido como scroll.
Valores possíveis: scroll		 Yes
x número inteiro A coordenada x onde ocorreu a rolagem. Yes
y número inteiro A coordenada y onde ocorreu a rolagem. Yes

OpenAI.ComputerActionType

Propriedade Valor
Tipo cadeia (de caracteres)
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 Predefinido
enviar SMS cadeia (de caracteres) O texto a ser digitado. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de tipo, esta propriedade é
sempre definido como type.
Valores possíveis: type		 Yes

OpenAI.ComputerActionWait

Uma ação de espera.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração Especifica o tipo de evento. Para uma ação de espera, esta propriedade é
sempre definido 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 Predefinido
ação OpenAI.ComputerAction Yes
call_id cadeia (de caracteres) 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 do 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 Predefinido
ação OpenAI.ComputerAction Yes
call_id cadeia (de caracteres) 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 do computador. Yes
estado enumeração O status do item. Um dos in_progress, completed, ou
incomplete. Preenchido quando os itens são retornados via API.
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração
Valores possíveis: computer_call		 Yes

OpenAI.ComputerToolCallOutputItemOutput

Discriminador para OpenAI.ComputerToolCallOutputItemOutput

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

Valor do tipo Esquema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
Nome Tipo Descrição Obrigatório Predefinido
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 Predefinido
identificação_de_ficheiro cadeia (de caracteres) Não
image_url cadeia (de caracteres) 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 (de caracteres)
Valores computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

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

Nome Tipo Descrição Obrigatório Predefinido
acknowledged_safety_checks matriz As verificações de segurança comunicadas pela API que foram reconhecidas pelo
desenvolvedor.		 Não
call_id cadeia (de caracteres) O ID da chamada de ferramenta de computador que produziu a saída. Yes
output 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 Predefinido
acknowledged_safety_checks matriz As verificações de segurança comunicadas pela API que foram reconhecidas pelo
desenvolvedor.		 Não
call_id cadeia (de caracteres) O ID da chamada de ferramenta de computador que produziu a saída. Yes
output OpenAI.ComputerToolCallOutputItemOutput Yes
estado enumeração O status do item. Um dos in_progress, completed, ou
incomplete. Preenchido quando os itens são retornados via API.
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração
Valores possíveis: computer_call_output		 Yes

OpenAI.ComputerToolCallSafetyCheck

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

Nome Tipo Descrição Obrigatório Predefinido
código cadeia (de caracteres) O tipo de verificação de segurança pendente. Yes
id cadeia (de caracteres) O ID da verificação de segurança pendente. Yes
mensagem cadeia (de caracteres) Detalhes sobre a verificação de segurança pendente. Yes

OpenAI.FerramentaDePréVisualizaçãoDeUsoDoComputador

Uma ferramenta que controla um computador virtual.

Nome Tipo Descrição Obrigatório Predefinido
altura do ecrã número inteiro A altura do ecrã do computador. Yes
largura de exibição número inteiro A largura do ecrã do computador. Yes
ambiente enumeração O tipo de ambiente de computador a controlar.
Valores possíveis: windows, mac, linux, ubuntu, , browser		 Yes
tipo enumeração O tipo de ferramenta de uso do computador. Sempre computer_use_preview.
Valores possíveis: computer_use_preview		 Yes

OpenAI.Coordenada

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

Nome Tipo Descrição Obrigatório Predefinido
x número inteiro A coordenada x. Yes
y número inteiro A coordenada y. Yes

OpenAI.CreateEmbeddingResponse

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

OpenAI.CreateEvalItem

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

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

OpenAI.CreateEvalRunRequest

Nome Tipo Descrição Obrigatório Predefinido
fonte_de_dados objecto Yes
└─ tipo OpenAI.EvalRunDataSourceType Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) 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 Predefinido
hiperparâmetros objecto Os hiperparâmetros usados para o trabalho de ajuste fino.
Esse valor agora é preterido em favor de method, e deve ser passado sob o method parâmetro.		 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 objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
método Método OpenAI.FineTune O método utilizado para o ajuste fino. Não
modelo string (ver modelos válidos abaixo) O nome do modelo a ser ajustado. Pode selecionar uma das opções
modelos suportados.		 Yes
sementes número inteiro A semente controla a reprodutibilidade do trabalho. Fornecer os mesmos parâmetros de semente e de trabalho deve produzir os mesmos resultados, mas poderá diferir em casos raros.
Se uma semente não for especificada, uma será gerada para você.		 Não
sufixo cadeia (de caracteres) Uma cadeia de até 64 caracteres que será adicionada ao nome do modelo ajustado.

Por exemplo, um suffix de "custom-model-name" produziria um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 Não Nenhum
ficheiro de treino cadeia (de caracteres) A ID de um arquivo carregado que contém dados de treinamento.

Consulte Carregar ficheiro para saber como carregar um ficheiro.

Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve fazer o upload do seu arquivo com a finalidade fine-tune.

O conteúdo do arquivo deve diferir dependendo se o modelo usa o bate-papo 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
ficheiro_de_validação cadeia (de caracteres) A ID de um arquivo carregado que contém dados de validação.

Se você fornecer esse arquivo, os dados serão usados para gerar validação
métricas periodicamente durante o ajuste fino. Essas métricas podem ser visualizadas em
O arquivo de resultados de ajuste fino.
Os mesmos dados não devem estar presentes nos processos de comboio e de validação.

Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve fazer o upload do 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

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

Valor do tipo Esquema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Nome Tipo Descrição Obrigatório Predefinido
tipo string (ver modelos válidos abaixo) Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração
Valores possíveis: wandb		 Yes
wandb objecto Yes
└─ entidade cadeia (de caracteres) Não
└─ nome cadeia (de caracteres) Não
└─ projeto cadeia (de caracteres) Não
└─ Tags matriz Não

OpenAI.CreateVectorStoreFileBatchRequest

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Não
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) arquivo(s). Se não estiver definido, usará a auto estratégia. Não
identificadores_de_arquivo matriz Uma lista de IDs de arquivo que o armazenamento de vetores deve usar. Útil para ferramentas como file_search essa podem acessar arquivos. Yes

OpenAI.CreateVectorStoreFileRequest

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Não
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) arquivo(s). Se não estiver definido, usará a auto estratégia. Não
identificação_de_ficheiro cadeia (de caracteres) Um ID de arquivo que o armazenamento de vetores deve usar. Útil para ferramentas como file_search essa podem acessar arquivos. Yes

OpenAI.CreateVectorStoreRequest

Nome Tipo Descrição Obrigatório Predefinido
chunking_strategy objecto A estratégia padrão. Esta estratégia utiliza atualmente um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400. Não
└─ estático OpenAI.StaticChunkingEstratégia Não
└─ tipo enumeração Sempre static.
Valores possíveis: static		 Não
expira após OpenAI.VectorStoreExpirationAfter A política de expiração para um repositório de vetores. Não
identificadores_de_arquivo matriz Uma lista de IDs de arquivo que o armazenamento de vetores deve usar. Útil para ferramentas como file_search essa podem acessar arquivos. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) O nome do repositório de vetores. Não

OpenAI.DeleteFileResponse

Nome Tipo Descrição Obrigatório Predefinido
Suprimido Booleano Yes
id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: file		 Yes

OpenAI.DeleteVectorStoreFileResponse

Nome Tipo Descrição Obrigatório Predefinido
Suprimido Booleano Yes
id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: vector_store.file.deleted		 Yes

OpenAI.DeleteVectorStoreResponse

Nome Tipo Descrição Obrigatório Predefinido
Suprimido Booleano Yes
id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: vector_store.deleted		 Yes

OpenAI.Incorporação

Representa um vetor de incorporação retornado pelo ponto de extremidade incorporado.

Nome Tipo Descrição Obrigatório Predefinido
incorporação matriz ou cadeia de caracteres Yes
indexar número inteiro O índice da incorporação na lista de incorporações. Yes
objecto enumeração O tipo de objeto, que está sempre "incorporando".
Valores possíveis: embedding		 Yes

OpenAI.Eval

Um objeto Eval com uma configuração de fonte de dados e critérios de teste. Um Eval representa uma tarefa para realizar na integração do seu LLM. Como:

  • Melhorar a qualidade do meu chatbot
  • Veja como meu chatbot lida bem com o suporte ao cliente
  • Verifique se o o4-mini é melhor no meu caso de uso do que o gpt-4o
Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro O carimbo de data/hora Unix (em segundos) referente à criação da avaliação. Yes
configuração_fonte_dados objecto Yes
└─ tipo OpenAI.EvalDataSourceConfigType Não
id cadeia (de caracteres) Identificador único para a avaliação. Yes
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
nome cadeia (de caracteres) O nome da avaliação. Yes
objecto enumeração O tipo de objeto.
Valores possíveis: eval		 Yes
critérios_teste matriz Uma lista de critérios de teste. Yes Nenhum

OpenAI.EvalApiError

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

Nome Tipo Descrição Obrigatório Predefinido
código cadeia (de caracteres) O código de erro. Yes
mensagem cadeia (de caracteres) 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 Predefinido
mensagens_de_entrada objecto Não
└─ referência_do_item cadeia (de caracteres) Uma referência a uma variável no item namespace. Ou seja, "item.input_trajectory" Não
└─ modelo matriz Uma lista de mensagens de bate-papo que formam o prompt ou o contexto. Pode incluir referências variáveis ao item namespace, 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 (de caracteres) O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini"). Não
parâmetros_de_amostragem AzureEvalAPICompletionsSamplingParams Não
origem objecto Yes
└─ conteúdo matriz O conteúdo do arquivo jsonl. Não
└─ criado_depois número inteiro Um carimbo de data/hora Unix opcional para filtrar itens criados após esse período. Não
└─ criado_antes número inteiro Um carimbo de data/hora Unix opcional para filtrar itens criados antes desse tempo. Não
└─ ID cadeia (de caracteres) O identificador do arquivo. Não
└─ limite número inteiro Um número máximo opcional de itens a devolver. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ modelo cadeia (de caracteres) Um modelo opcional para filtrar (por exemplo, 'gpt-4o'). Não
└─ tipo enumeração O tipo de fonte. 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 para a fonte de dados usada para as execuções de avaliação. Este esquema é usado para definir a forma dos dados que serão:

  • Usado 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 Predefinido
incluir_schema_exemplo Booleano Se o processo de 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
item_esquema objecto 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 do seu item e, opcionalmente, dos seus sample namespaces. O esquema de resposta define a forma dos dados que serão:

  • Usado 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 Predefinido
esquema objecto 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

Este 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 Predefinido
tipo OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigResource

Discriminador para OpenAI.EvalDataSourceConfigResource

Este 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 Predefinido
tipo OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigType

Propriedade Valor
Tipo cadeia (de caracteres)
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 Predefinido
dados introduzidos matriz Uma lista de mensagens de bate-papo que formam o prompt ou o contexto. Pode incluir referências variáveis ao item namespace, ou seja, {{item.name}}. Yes
rótulos matriz Os rótulos para classificar cada item na avaliação. Yes
modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Deve suportar resultados estruturados. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
etiquetas_de_passagem matriz Os rótulos que indicam um resultado positivo. 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 Predefinido
dados introduzidos matriz Yes
rótulos matriz Os rótulos a atribuir a cada item na avaliação. Yes
modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Deve suportar resultados estruturados. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
etiquetas_de_passagem matriz Os rótulos que indicam um resultado positivo. 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

Este 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 Predefinido
tipo OpenAI.GraderType Yes

OpenAI.EvalGraderPythonParams

Nome Tipo Descrição Obrigatório Predefinido
image_tag cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
nome cadeia (de caracteres) O nome do classificador. Yes
limite_de_passagem número O limiar para a pontuação. Não
origem cadeia (de caracteres) 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 Predefinido
image_tag cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
nome cadeia (de caracteres) O nome do classificador. Yes
limite_de_passagem número O limiar para a pontuação. Não
origem cadeia (de caracteres) 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

Este 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 Predefinido
tipo OpenAI.GraderType Yes

OpenAI.EvalGraderScoreModelParams

Nome Tipo Descrição Obrigatório Predefinido
dados introduzidos matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
limite_de_passagem número O limiar para a pontuação. Não
intervalo matriz O intervalo da pontuação. O padrão é [0, 1]. Não
parâmetros_de_amostragem Os parâmetros de amostragem para o 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 Predefinido
dados introduzidos matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
limite_de_passagem número O limiar para a pontuação. Não
intervalo matriz O intervalo da pontuação. O padrão é [0, 1]. Não
parâmetros_de_amostragem Os parâmetros de amostragem para o 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 Predefinido
dados introduzidos cadeia (de caracteres) O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Yes
referenciar cadeia (de caracteres) 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 Predefinido
métrica de avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Yes
dados introduzidos cadeia (de caracteres) O texto que está a ser classificado. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
limite_de_passagem número O limiar para a pontuação. Yes
referenciar cadeia (de caracteres) O texto que está a ser avaliado. Yes
tipo enumeração O tipo de motoniveladora.
Valores possíveis: text_similarity		 Yes

OpenAI.EvalGraderTextSimilarityResource

Nome Tipo Descrição Obrigatório Predefinido
métrica de avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Yes
dados introduzidos cadeia (de caracteres) O texto que está a ser classificado. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
limite_de_passagem número O limiar para a pontuação. Yes
referenciar cadeia (de caracteres) O texto que está a ser avaliado. Yes
tipo enumeração O tipo de motoniveladora.
Valores possíveis: text_similarity		 Yes

OpenAI.EvalItem

Uma entrada de mensagem para o modelo com uma função que indica a adesão a uma hierarquia de instruções. As instruções dadas com a developer função ou system têm precedência sobre as instruções dadas com a user função. 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 Predefinido
conteúdo objecto Yes
└─ tipo OpenAI.EvalItemContentType Não
função enumeração A função da entrada de mensagem. Um dos user, assistant, system, ou
developer.
Valores possíveis: user, assistant, system, developer		 Yes
tipo enumeração O tipo de entrada de mensagem. Sempre message.
Valores possíveis: message		 Não

OpenAI.EvalItemContent

Discriminador para OpenAI.EvalItemContent

Este 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 Predefinido
tipo OpenAI.EvalItemContentType Yes

OpenAI.EvalItemContentInputText

Nome Tipo Descrição Obrigatório Predefinido
enviar SMS cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: input_text		 Yes

OpenAI.EvalItemContentOutputText

Nome Tipo Descrição Obrigatório Predefinido
enviar SMS cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: output_text		 Yes

OpenAI.EvalItemContentType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

Um objeto JsonlRunDataSource que especifica um ficheiro JSONL que corresponde à avaliação.

Nome Tipo Descrição Obrigatório Predefinido
origem objecto Yes
└─ conteúdo matriz O conteúdo do arquivo jsonl. Não
└─ ID cadeia (de caracteres) O identificador do arquivo. Não
└─ tipo enumeração 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 avaliações.

Nome Tipo Descrição Obrigatório Predefinido
dados matriz Uma matriz de objetos eval. Yes
first_id cadeia (de caracteres) O identificador da primeira avaliação na matriz de dados. Yes
tem_mais Booleano Indica se há mais avaliações disponíveis. Yes
last_id cadeia (de caracteres) O identificador da última avaliação no array de dados. Yes
objecto enumeração O tipo deste objeto. É sempre definido como "lista".
Valores possíveis: list		 Yes

OpenAI.EvalLogsDataSourceConfigParams

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

Nome Tipo Descrição Obrigatório Predefinido
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 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=v2, etc. O esquema retornado por essa configuração de fonte de dados é usado para definir quais variáveis estão disponíveis em seus evals. item e sample ambos são definidos ao usar essa configuração de fonte de dados.

Nome Tipo Descrição Obrigatório Predefinido
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
esquema objecto 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 Predefinido
mensagens_de_entrada objecto Não
└─ referência_do_item cadeia (de caracteres) Uma referência a uma variável no item namespace. Ou seja, "item.name" Não
└─ modelo matriz Uma lista de mensagens de bate-papo que formam o prompt ou o contexto. Pode incluir referências variáveis ao item namespace, 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 (de caracteres) O nome do modelo a ser usado para gerar completações (por exemplo, "o3-mini"). Não
parâmetros_de_amostragem AzureEvalAPIResponseSamplingParams Não
origem objecto Yes
└─ conteúdo matriz O conteúdo do arquivo jsonl. Não
└─ criado_depois número inteiro Inclua apenas itens criados após esse carimbo de data/hora (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ criado_antes número inteiro Inclua apenas itens criados antes desse carimbo de data/hora (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ ID cadeia (de caracteres) O identificador do arquivo. Não
└─ instruções_busca cadeia (de caracteres) String opcional para pesquisar o campo 'instruções'. Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ modelo cadeia (de caracteres) O nome do modelo para o qual encontrar respostas. Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ esforço_de_raciocínio OpenAI.ReasoningEffort Parâmetro de esforço de raciocínio opcional. Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ temperatura número Temperatura de amostragem. Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ Ferramentas matriz Lista de nomes de ferramentas. Este é um parâmetro de consulta usado para selecionar respostas. Não
└─ top_p número Parâmetro de amostragem do núcleo. Este é 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
└─ Utilizadores matriz Lista de identificadores de usuário. Este é 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 uma execução de avaliação.

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro Carimbo de data/hora Unix (em segundos) quando o processo de avaliação foi criado. Yes
fonte_de_dados objecto Yes
└─ tipo OpenAI.EvalRunDataSourceType Não
erro OpenAI.EvalApiError Um objeto que representa uma resposta de erro da API Eval. Yes
eval_id cadeia (de caracteres) O identificador da avaliação associada. Yes
id cadeia (de caracteres) Identificador exclusivo para a execução da avaliação. Yes
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
modelo cadeia (de caracteres) O modelo avaliado, se aplicável. Yes
nome cadeia (de caracteres) O nome da sessão de avaliação. Yes
objecto enumeração O tipo do objeto. Sempre «eval.run».
Valores possíveis: eval.run		 Yes
uso_por_modelo matriz Estatísticas de uso para cada modelo durante a execução da avaliação. Yes
por_resultados_dos_criterios_de_teste matriz Resultados por critério de teste aplicado durante a execução da avaliação. Yes
report_url cadeia (de caracteres) A URL para o relatório da execução da avaliação gerada no painel de controlo da interface do utilizador. Yes
contagem_resultados objecto Contadores resumindo os resultados da execução de avaliação. Yes
└─ Erro número inteiro Número de itens de saída que resultaram em um erro. Não
└─ não conseguiu número inteiro Número de itens de saída que não passaram na avaliação. Não
└─ aprovado número inteiro Número de itens de saída que passaram na avaliação. Não
└─ total número inteiro Número total de itens de saída executados. Não
estado cadeia (de caracteres) O estado da execução da avaliação. Yes

OpenAI.EvalRunDataContentSource

Discriminador para OpenAI.EvalRunDataContentSource

Este 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 Predefinido
tipo OpenAI.EvalRunDataContentSourceType Yes

OpenAI.EvalRunDataContentSourceType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

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

OpenAI.EvalRunDataSourceJsonlResource

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

OpenAI.EvalRunDataSourceParams

Discriminador para OpenAI.EvalRunDataSourceParams

Este 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 Predefinido
tipo OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResource

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

OpenAI.EvalRunDataSourceResponsesResource

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

OpenAI.EvalRunDataSourceType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

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

OpenAI.EvalRunFileIdDataContentSource

Nome Tipo Descrição Obrigatório Predefinido
id cadeia (de caracteres) O identificador do arquivo. Yes
tipo enumeração 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 Predefinido
dados matriz Uma matriz de objetos de avaliação. Yes
first_id cadeia (de caracteres) O identificador da primeira execução de avaliação na matriz de dados. Yes
tem_mais Booleano Indica se há mais avaliações disponíveis. Yes
last_id cadeia (de caracteres) O identificador da última execução eval na matriz de dados. Yes
objecto enumeração O tipo deste objeto. É sempre definido como "lista".
Valores possíveis: list		 Yes

OpenAI.EvalRunOutputItem

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

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro Carimbo de data/hora Unix (em segundos) quando o processo de avaliação foi criado. Yes
item_de_fonte_de_dados objecto Detalhes do item da fonte de dados de entrada. Yes
id_item_fonte_de_dados número inteiro O identificador do item da fonte de dados. Yes
eval_id cadeia (de caracteres) O identificador do grupo de avaliação. Yes
id cadeia (de caracteres) Identificador único para o item de saída do processo de avaliação. Yes
objecto enumeração O tipo do objeto. Sempre "eval.run.output_item".
Valores possíveis: eval.run.output_item		 Yes
Resultados matriz Uma lista dos resultados da execução da avaliação. Yes
identificador_de_execução cadeia (de caracteres) O identificador da execução de avaliação associada a este item de saída. Yes
amostra objecto Uma amostra contendo a entrada e saída do teste de avaliação. Yes
└─ erro OpenAI.EvalApiError Um objeto que representa uma resposta de erro da API Eval. Não
└─ motivo de término cadeia (de caracteres) A razão pela qual a geração da amostra foi concluída. Não
└─ entrada matriz Uma matriz de mensagens de entrada. Não
└─ max_completion_tokens número inteiro O número máximo de tokens permitido para conclusão. Não
└─ modelo cadeia (de caracteres) O modelo usado para gerar a amostra. Não
└─ saída matriz Uma matriz de mensagens de saída. Não
└─ sementes número inteiro A semente utilizada para gerar a amostra. Não
└─ temperatura número A temperatura de amostragem utilizada. Não
└─ top_p número O valor de top_p utilizado na amostragem. Não
└─ utilização objecto Detalhes de uso do token para o exemplo. Não
└─ tokens em cache número inteiro O número de tokens recuperados do cache. Não
└─ tokens de conclusão número inteiro O número de tokens de conclusão gerados. Não
└─ prompt_tokens número inteiro O número de tokens de prompt usados. Não
└─ fichas_totais número inteiro O número total de tokens usados. Não
estado cadeia (de caracteres) O estado 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 Predefinido
dados matriz Um conjunto de objetos de itens de saída do eval. Yes
first_id cadeia (de caracteres) O identificador do primeiro item de saída da execução de avaliação na matriz de dados. Yes
tem_mais Booleano Indica se existem mais itens de saída disponíveis da execução de avaliação. Yes
last_id cadeia (de caracteres) O identificador do último item de saída da execução de avaliação na matriz de dados. Yes
objecto enumeração O tipo deste objeto. É 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 Predefinido
criado_depois número inteiro Inclua apenas itens criados após esse carimbo de data/hora (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. Não
criado_antes número inteiro Inclua apenas itens criados antes desse carimbo de data/hora (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. Não
instructions_search cadeia (de caracteres) String opcional para pesquisar o campo 'instruções'. Este é um parâmetro de consulta usado para selecionar respostas. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
modelo cadeia (de caracteres) O nome do modelo para o qual encontrar respostas. Este é um parâmetro de consulta usado para selecionar respostas. Não
esforço de raciocínio objecto apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
temperatura número Temperatura de amostragem. Este é um parâmetro de consulta usado para selecionar respostas. Não
Ferramentas matriz Lista de nomes de ferramentas. Este é um parâmetro de consulta usado para selecionar respostas. Não
top_p número Parâmetro de amostragem do núcleo. Este é 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
utilizadores matriz Lista de identificadores de usuário. Este é um parâmetro de consulta usado para selecionar respostas. Não

OpenAI.EvalRunStoredCompletionsDataContentSource

Uma configuração StoredCompletionsRunDataSource descrevendo um conjunto de filtros

Nome Tipo Descrição Obrigatório Predefinido
criado_depois número inteiro Um carimbo de data/hora Unix opcional para filtrar itens criados após esse período. Não
criado_antes número inteiro Um carimbo de data/hora Unix opcional para filtrar itens criados antes desse tempo. Não
limite número inteiro Um número máximo opcional de itens a devolver. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
modelo cadeia (de caracteres) Um modelo opcional para filtrar (por exemplo, 'gpt-4o'). Não
tipo enumeração O tipo de fonte. Sempre stored_completions.
Valores possíveis: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Preterido em favor de LogsDataSourceConfig.

Nome Tipo Descrição Obrigatório Predefinido
metadados objecto Filtros de metadados para a fonte de dados de conclusão armazenada. 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 Predefinido
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
esquema objecto 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 procura conteúdo relevante a partir de ficheiros carregados.

Nome Tipo Descrição Obrigatório Predefinido
filtros objecto Não
máximo_número_de_resultados número inteiro O número máximo de resultados a serem retornados. Este número deve situar-se entre 1 e 50, inclusive. Não
opções_de_classificação objecto Nã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 ficheiros, 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 ficheiros. Sempre file_search.
Valores possíveis: file_search		 Yes
identificadores_de_armazém_de_vectores matriz Os IDs do vetor armazena para pesquisar. Yes

OpenAI.FileSearchToolCallItemParam

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

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

OpenAI.FileSearchToolCallItemResource

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

Nome Tipo Descrição Obrigatório Predefinido
queries matriz As consultas usadas para procurar arquivos. Yes
Resultados matriz Os resultados da chamada da ferramenta de pesquisa de ficheiros. Não
estado enumeração O status da chamada da ferramenta de pesquisa de arquivos. Um dos 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.Filtros

Nome Tipo Descrição Obrigatório Predefinido
filtros matriz Matriz de filtros para combinar. Os itens podem ser ComparisonFilter ou CompoundFilter. Yes
chave cadeia (de caracteres) A chave pela qual se compara o valor. Yes
tipo enumeração Tipo de operação: and ou or.
Valores possíveis: and, or		 Yes
valor string ou número ou booleano O valor a ser comparado com a chave de atributo; suporta tipos de string, número ou booleanos. Yes

OpenAI.FineTuneDPOHyperparameters

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

Nome Tipo Descrição Obrigatório Predefinido
tamanho do lote enumeração
Valores possíveis: auto		 Não
beta enumeração
Valores possíveis: auto		 Não
multiplicador_da_taxa_de_aprendizagem enumeração
Valores possíveis: auto		 Não
número_de_épocas enumeração
Valores possíveis: auto		 Não

OpenAI.FineTuneDPOMethod

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

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

Método OpenAI.FineTune

O método utilizado para o ajuste fino.

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

OpenAI.FineTuneReinforcementHyperparameters

Os hiperparâmetros utilizados para o trabalho de ajuste fino de reforço.

Nome Tipo Descrição Obrigatório Predefinido
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_aprendizagem enumeração
Valores possíveis: auto		 Não
número_de_é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, medium, high		 Não

OpenAI.FineTuneSupervisedHyperparameters

Os hiperparâmetros usados para o trabalho de ajuste fino.

Nome Tipo Descrição Obrigatório Predefinido
tamanho do lote enumeração
Valores possíveis: auto		 Não
multiplicador_da_taxa_de_aprendizagem enumeração
Valores possíveis: auto		 Não
número_de_épocas enumeração
Valores possíveis: auto		 Não

OpenAI.FineTuneSupervisedMethod

Configuração para o método de ajuste fino supervisionado.

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

OpenAI.FineTuningIntegration

Discriminador para OpenAI.FineTuningIntegration

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

Valor do tipo Esquema
wandb OpenAI.FineTuningIntegrationWandb
Nome Tipo Descrição Obrigatório Predefinido
tipo string (ver modelos válidos abaixo) Yes

OpenAI.FineTuningIntegrationWandb

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo de integração que está sendo habilitado para o trabalho de ajuste fino
Valores possíveis: wandb		 Yes
wandb objecto As configurações para sua integração com pesos e vieses. Esta carga especifica o projeto que
As métricas serão enviadas para. Opcionalmente, você pode definir um nome de exibição explícito para sua execução, adicionar tags
para sua execução e defina uma entidade padrão (equipe, nome de usuário, etc.) para ser associada à sua execução.		 Yes
└─ entidade cadeia (de caracteres) 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ê faria
como associado à corrida. Se não estiver definida, a entidade padrão para a chave WandB API registrada será usada.		 Não
└─ nome cadeia (de caracteres) Um nome de exibição a ser definido para a execução. Se não estiver definido, usaremos o ID do trabalho como o nome. Não
└─ projeto cadeia (de caracteres) O nome do projeto sob o qual a nova execução será criada. Não
└─ Tags matriz Uma lista de tags a serem anexadas à execução recém-criada. Essas tags são passadas diretamente para WandB. Alguns
as tags padrão são geradas pelo OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".		 Não

OpenAI.FineTuningJob

O fine_tuning.job objeto representa um trabalho de ajuste fino que foi criado por meio da API.

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro O carimbo de data/hora do Unix (em segundos) para quando o trabalho de ajuste fino foi criado. Yes
erro objecto Para trabalhos de ajuste fino que têm failed, isso conterá mais informações sobre a causa da falha. Yes
└─ código cadeia (de caracteres) Um código de erro legível por máquina. Não
└─ mensagem cadeia (de caracteres) Uma mensagem de erro legível por humanos. Não
└─ parâmetro cadeia (de caracteres) O parâmetro que era inválido, geralmente training_file ou validation_file. Este campo será nulo se a falha não for específica do parâmetro. Não
conclusão_estimada número inteiro O carimbo de data/hora do Unix (em segundos) para quando o trabalho de ajuste fino é estimado para terminar. O valor será nulo se o trabalho de ajuste fino não estiver em execução. Não
modelo ajustado cadeia (de caracteres) 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
concluído_em número inteiro O carimbo de data/hora do Unix (em segundos) para 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 objecto Os hiperparâmetros usados para o trabalho de ajuste fino. Esse valor só será retornado ao executar supervised trabalhos. 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 (de caracteres) O identificador de 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 objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
método Método OpenAI.FineTune O método utilizado para o ajuste fino. Não
modelo cadeia (de caracteres) O modelo base que está a ser ajustado. Yes
objecto enumeração O tipo de objeto, que é sempre "fine_tuning.job".
Valores possíveis: fine_tuning.job		 Yes
organization_id cadeia (de caracteres) A organização proprietária do trabalho de ajuste fino. Yes
ficheiros_resultado matriz O(s) ID(s) do arquivo de resultados compilados para o trabalho de ajuste fino. Você pode recuperar os resultados com a API de arquivos. Yes
sementes número inteiro A semente usada para o trabalho de ajuste de precisão. Yes
estado enumeração O status atual do trabalho de ajuste fino, que pode ser , , , , validating_filesqueued, ou running. succeededfailedcancelled
Valores possíveis: validating_files, queued, running, succeeded, , failed, cancelled		 Yes
trained_tokens número 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
ficheiro de treino cadeia (de caracteres) O ID do arquivo usado para treinamento. Você pode recuperar os dados de treinamento com a API de arquivos. Yes
user_provided_suffix cadeia (de caracteres) O sufixo descritivo aplicado ao trabalho, conforme especificado na solicitação de criação de trabalho. Não
ficheiro_de_validação cadeia (de caracteres) O ID do arquivo usado para validação. Você pode recuperar os resultados da validação com a API de arquivos. Yes

OpenAI.FineTuningJobCheckpoint

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

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro O carimbo de data/hora Unix (em segundos) para quando o ponto de verificação foi criado. Yes
ponto de verificação do modelo ajustado cadeia (de caracteres) O nome do modelo de ponto de verificação ajustado que é criado. Yes
ID_de_tarefa_de_ajuste_fino cadeia (de caracteres) O nome do trabalho de ajuste fino a partir do qual esse ponto de verificação foi criado. Yes
id cadeia (de caracteres) O identificador de ponto de verificação, que pode ser referenciado nos pontos de extremidade da API. Yes
métricas objecto Métricas no número da etapa durante o trabalho de ajuste fino. Yes
└─ perda_validação_completa número Não
└─ precisão_média_do_token_válido_total número Não
└─ passo número Não
└─ perda_treino número Não
└─ precisão_média_de_tokens_de_treinamento número Não
└─ perda_de_validação número Não
└─ precisão_média_do_token_válido número Não
objecto enumeração O tipo de objeto, que é sempre "fine_tuning.job.checkpoint".
Valores possíveis: fine_tuning.job.checkpoint		 Yes
número_etapa número inteiro O número da etapa em que o ponto de verificação foi criado. Yes

OpenAI.FineTuningJobEvent

Ajustando o objeto de evento de trabalho

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro O carimbo de data/hora do Unix (em segundos) para quando o trabalho de ajuste fino foi criado. Yes
dados Os dados associados ao evento. Não
id cadeia (de caracteres) O identificador de objeto. Yes
nível enumeração O nível de log do evento.
Valores possíveis: info, warn, error		 Yes
mensagem cadeia (de caracteres) A mensagem do evento. Yes
objecto enumeração O tipo de objeto, que é sempre "fine_tuning.job.event".
Valores possíveis: fine_tuning.job.event		 Yes
tipo enumeração O tipo de evento.
Valores possíveis: message, metrics		 Não

OpenAI.FunctionObject

Nome Tipo Descrição Obrigatório Predefinido
descrição cadeia (de caracteres) 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 (de caracteres) 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 que as funções aceitam, 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 Booleano Se a adesão estrita ao esquema deve ser ativada ao gerar a chamada de função. Se definido como true, o modelo seguirá o esquema exato definido no parameters campo. Somente um subconjunto de esquema JSON é suportado quando strict é true. Saiba mais sobre Saídas Estruturadas no guia de chamada de funções. Não Falso

OpenAI.FunctionTool

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

Nome Tipo Descrição Obrigatório Predefinido
descrição cadeia (de caracteres) 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 (de caracteres) 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 Booleano Se a validação de parâmetros estrita deve ser imposta. 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 Predefinido
arguments cadeia (de caracteres) Uma cadeia de caracteres JSON dos argumentos a serem passados para a função. Yes
call_id cadeia (de caracteres) O ID exclusivo da chamada de ferramenta de função gerada pelo modelo. Yes
nome cadeia (de caracteres) 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 Predefinido
arguments cadeia (de caracteres) Uma cadeia de caracteres JSON dos argumentos a serem passados para a função. Yes
call_id cadeia (de caracteres) O ID exclusivo da chamada de ferramenta de função gerada pelo modelo. Yes
nome cadeia (de caracteres) O nome da função a ser executada. Yes
estado enumeração O status do item. Um dos in_progress, completed, ou
incomplete. Preenchido quando os itens são retornados via API.
Valores possíveis: in_progress, completed, incomplete		 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 Predefinido
call_id cadeia (de caracteres) O ID exclusivo da chamada de ferramenta de função gerada pelo modelo. Yes
output cadeia (de caracteres) 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 Predefinido
call_id cadeia (de caracteres) O ID exclusivo da chamada de ferramenta de função gerada pelo modelo. Yes
output cadeia (de caracteres) Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função. Yes
estado enumeração O status do item. Um dos in_progress, completed, ou
incomplete. Preenchido quando os itens são retornados via API.
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração
Valores possíveis: function_call_output		 Yes

OpenAI.Grader

Discriminador para OpenAI.Grader

Este 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 Predefinido
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 Predefinido
dados introduzidos matriz Yes
rótulos matriz Os rótulos a atribuir a cada item na avaliação. Yes
modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Deve suportar resultados estruturados. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
etiquetas_de_passagem matriz Os rótulos que indicam um resultado positivo. 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 a saída de vários classificadores para produzir uma única pontuação.

Nome Tipo Descrição Obrigatório Predefinido
calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Yes
Motoniveladoras objecto Yes
nome cadeia (de caracteres) O nome do classificador. 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 Predefinido
image_tag cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
nome cadeia (de caracteres) O nome do classificador. Yes
origem cadeia (de caracteres) 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 Predefinido
dados introduzidos matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
intervalo matriz O intervalo da pontuação. O padrão é [0, 1]. Não
parâmetros_de_amostragem Os parâmetros de amostragem para o 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 Predefinido
dados introduzidos cadeia (de caracteres) O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Yes
referenciar cadeia (de caracteres) 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 Predefinido
métrica de avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Yes
dados introduzidos cadeia (de caracteres) O texto que está a ser classificado. Yes
nome cadeia (de caracteres) O nome do classificador. Yes
referenciar cadeia (de caracteres) O texto que está a ser avaliado. Yes
tipo enumeração O tipo de motoniveladora.
Valores possíveis: text_similarity		 Yes

OpenAI.GraderType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

Uma ferramenta que gera imagens usando um modelo como a série gpt-image-1.

Nome Tipo Descrição Obrigatório Predefinido
em segundo plano enumeração Tipo de plano de fundo para a imagem gerada. Um dos transparent,
opaque, ou auto. Padrão: auto.
Valores possíveis: transparent, opaque, auto		 Não
máscara_da_imagem_de_entrada objecto Máscara opcional para inpainting. Contém image_url
(string, opcional) e file_id (string, opcional).		 Não
└─ id_do_arquivo cadeia (de caracteres) ID do ficheiro para a imagem da máscara. Não
└─ image_url cadeia (de caracteres) 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 número inteiro Nível de compressão para a imagem de saída. Padrão: 100. Não 100
formato_de_saida enumeração O formato de saída da imagem gerada. Um dos png, webp, ou
jpeg. Padrão: png.
Valores possíveis: png, webp, jpeg		 Não
imagens parciais número inteiro Número de imagens parciais para gerar no modo de streaming, de 0 (valor padrão) a 3. Não 0
qualidade enumeração A qualidade da imagem gerada. Um dos low, medium, high,
ou auto. Padrão: auto.
Valores possíveis: low, medium, high, auto		 Não
tamanho enumeração O tamanho da imagem gerada. Um dos 1024x1024, 1024x1536,
1536x1024, ou auto. Padrão: auto.
Valores possíveis: 1024x1024, 1024x1536, 1536x1024, auto		 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

Um pedido de geração de imagem feito pelo modelo.

Nome Tipo Descrição Obrigatório Predefinido
Resultado cadeia (de caracteres) A imagem gerada codificada em base64. Yes
tipo enumeração
Valores possíveis: image_generation_call		 Yes

OpenAI.ImageGenToolCallItemResource

Um pedido de geração de imagem feito pelo modelo.

Nome Tipo Descrição Obrigatório Predefinido
Resultado cadeia (de caracteres) A imagem gerada codificada em base64. Yes
estado enumeração
Valores possíveis: in_progress, completed, generating, failed		 Yes
tipo enumeração
Valores possíveis: image_generation_call		 Yes

OpenAI.ImplicitUserMessage

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

OpenAI.Includable

Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores atualmente suportados são:

  • code_interpreter_call.outputs: Inclui as saídas da execução de código python em itens de chamada da ferramenta interpretadora de código.
  • computer_call_output.output.image_url: Inclua urls de imagem da saída de 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 nas saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de várias voltas ao usar a API de respostas sem estado (como quando o store parâmetro é definido como false, ou quando uma organização está inscrita 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. Atualmente
Os valores suportados são:
- code_interpreter_call.outputs: Inclui as saídas de execução de código python
na ferramenta interpretador de código, chamar itens.
- computer_call_output.output.image_url: Inclua urls de imagem da saída de chamada do computador.
- file_search_call.results: Incluir os resultados da pesquisa de
a chamada da ferramenta de pesquisa de ficheiros.
- 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 encriptada do raciocínio
tokens em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em
conversas com vários turnos ao usar a API de respostas sem estado (como
quando o store parâmetro é definido como false, ou quando uma organização é
inscritos no programa de retenção de dados zero).
Tipo cadeia (de caracteres)
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

Este 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 Predefinido
tipo OpenAI.ItemContentType Conteúdos multimodais de entrada e saída. Yes

OpenAI.ItemContentInputAudio

Uma entrada de áudio para o modelo.

Nome Tipo Descrição Obrigatório Predefinido
dados cadeia (de caracteres) Dados de áudio codificados em Base64. Yes
format enumeração O formato dos dados de áudio. Os formatos atualmente suportados 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 Predefinido
file_data cadeia (de caracteres) O conteúdo do arquivo a ser enviado para o modelo. Não
identificação_de_ficheiro cadeia (de caracteres) A ID do arquivo a ser enviado para o modelo. Não
nome do ficheiro cadeia (de caracteres) 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 Predefinido
detail enumeração O nível de detalhe da imagem a ser enviada para o modelo. Um de high, lowou auto. O padrão é auto.
Valores possíveis: low, high, auto		 Não
identificação_de_ficheiro cadeia (de caracteres) A ID do arquivo a ser enviado para o modelo. Não
image_url cadeia (de caracteres) O URL da imagem a ser enviada para o modelo. Um URL totalmente qualificado ou uma imagem codificada em base64 em um 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 Predefinido
enviar SMS cadeia (de caracteres) 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 Predefinido
dados cadeia (de caracteres) Dados de áudio codificados em Base64 do modelo. Yes
transcrição cadeia (de caracteres) A transcrição dos dados de áudio do modelo. Yes
tipo enumeração O tipo de á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 Predefinido
anotações matriz As anotações da saída de texto. Yes
Logprobs matriz Não
enviar SMS cadeia (de caracteres) 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 Predefinido
recusa cadeia (de caracteres) A explicação da recusa do modelo. Yes
tipo enumeração O tipo de recusa. Sempre refusal.
Valores possíveis: refusal		 Yes

OpenAI.ItemContentType

Conteúdos multimodais de entrada e saída.

Propriedade Valor
Descrição Conteúdos multimodais de entrada e saída.
Tipo cadeia (de caracteres)
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

Este 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 Predefinido
tipo OpenAI.ItemType Yes

OpenAI.ItemReferenceItemParam

Um identificador interno para um item a ser referenciado.

Nome Tipo Descrição Obrigatório Predefinido
id cadeia (de caracteres) A ID originada pelo serviço do item de resposta gerado anteriormente que está 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

Este 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 Predefinido
id cadeia (de caracteres) Yes
tipo OpenAI.ItemType Yes

OpenAI.ItemType

Propriedade Valor
Tipo cadeia (de caracteres)
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 Predefinido
dados matriz Yes
first_id cadeia (de caracteres) Não
tem_mais Booleano Yes
last_id cadeia (de caracteres) Não
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListFineTuningJobEventsResponse

Nome Tipo Descrição Obrigatório Predefinido
dados matriz Yes
tem_mais Booleano Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListModelsResponse

Nome Tipo Descrição Obrigatório Predefinido
dados matriz Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Nome Tipo Descrição Obrigatório Predefinido
dados matriz Yes
tem_mais Booleano Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListVectorStoreFilesFilter

Propriedade Valor
Tipo cadeia (de caracteres)
Valores in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Nome Tipo Descrição Obrigatório Predefinido
dados matriz Yes
first_id cadeia (de caracteres) Yes
tem_mais Booleano Yes
last_id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListVectorStoresResponse

Nome Tipo Descrição Obrigatório Predefinido
dados matriz Yes
first_id cadeia (de caracteres) Yes
tem_mais Booleano Yes
last_id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.LocalShellExecAction

Execute um comando shell no servidor.

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

OpenAI.LocalShellTool

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

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo da ferramenta 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 Predefinido
ação OpenAI.LocalShellExecAction Execute um comando shell no servidor. Yes
call_id cadeia (de caracteres) A ID exclusiva da chamada de 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 Predefinido
ação OpenAI.LocalShellExecAction Execute um comando shell no servidor. Yes
call_id cadeia (de caracteres) A ID exclusiva da chamada de ferramenta de shell local gerada pelo modelo. Yes
estado enumeração
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração
Valores possíveis: local_shell_call		 Yes

OpenAI.LocalShellToolCallOutputItemParam

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

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

OpenAI.LocalShellToolCallOutputItemResource

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

Nome Tipo Descrição Obrigatório Predefinido
output cadeia (de caracteres) Uma cadeia de caracteres JSON da saída da chamada da ferramenta shell local. Yes
estado enumeração
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração
Valores possíveis: local_shell_call_output		 Yes

OpenAI.Localização

Discriminador para OpenAI.Location

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

Valor do tipo Esquema
approximate OpenAI.AproximadaLocalização
Nome Tipo Descrição Obrigatório Predefinido
tipo OpenAI.LocationType Yes

OpenAI.LocationType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores approximate

OpenAI.LogProb

A probabilidade de log de um token.

Nome Tipo Descrição Obrigatório Predefinido
bytes matriz Yes
Logprob número Yes
token cadeia (de caracteres) Yes
top_logprobs matriz Yes

OpenAI.MCPApprovalRequestItemParam

Um pedido de aprovação humana de uma invocação de ferramenta.

Nome Tipo Descrição Obrigatório Predefinido
arguments cadeia (de caracteres) Uma cadeia de argumentos JSON para a ferramenta. Yes
nome cadeia (de caracteres) O nome da ferramenta a ser executada. Yes
rótulo de servidor cadeia (de caracteres) O rótulo do servidor MCP que faz a solicitação. Yes
tipo enumeração
Valores possíveis: mcp_approval_request		 Yes

OpenAI.MCPApprovalRequestItemResource

Um pedido de aprovação humana de uma invocação de ferramenta.

Nome Tipo Descrição Obrigatório Predefinido
arguments cadeia (de caracteres) Uma cadeia de argumentos JSON para a ferramenta. Yes
nome cadeia (de caracteres) O nome da ferramenta a ser executada. Yes
rótulo de servidor cadeia (de caracteres) O rótulo do servidor MCP que faz 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 de MCP.

Nome Tipo Descrição Obrigatório Predefinido
approval_request_id cadeia (de caracteres) O ID do pedido de aprovação que está a ser respondido. Yes
aprovar Booleano Se o pedido foi aprovado. Yes
razão cadeia (de caracteres) Motivo facultativo da 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 de MCP.

Nome Tipo Descrição Obrigatório Predefinido
approval_request_id cadeia (de caracteres) O ID do pedido de aprovação que está a ser respondido. Yes
aprovar Booleano Se o pedido foi aprovado. Yes
razão cadeia (de caracteres) Motivo facultativo da 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 Predefinido
arguments cadeia (de caracteres) Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta. Yes
erro cadeia (de caracteres) O erro da chamada de ferramenta, se houver. Não
nome cadeia (de caracteres) O nome da ferramenta que foi executada. Yes
output cadeia (de caracteres) A saída da chamada da ferramenta. Não
rótulo de servidor cadeia (de caracteres) 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 Predefinido
arguments cadeia (de caracteres) Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta. Yes
erro cadeia (de caracteres) O erro da chamada de ferramenta, se houver. Não
nome cadeia (de caracteres) O nome da ferramenta que foi executada. Yes
output cadeia (de caracteres) A saída da chamada da ferramenta. Não
rótulo de servidor cadeia (de caracteres) 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 Predefinido
erro cadeia (de caracteres) Mensagem de erro se o servidor não pôde listar ferramentas. Não
rótulo de servidor cadeia (de caracteres) 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 Predefinido
erro cadeia (de caracteres) Mensagem de erro se o servidor não pôde listar ferramentas. Não
rótulo de servidor cadeia (de caracteres) 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 Predefinido
anotações Anotações adicionais sobre a ferramenta. Não
descrição cadeia (de caracteres) A descrição da ferramenta. Não
input_schema O esquema JSON que descreve a entrada da ferramenta. Yes
nome cadeia (de caracteres) O nome da ferramenta. Yes

OpenAI.MCPTool

Dê ao modelo acesso a ferramentas adicionais por meio de servidores MCP (Model Context Protocol) remotos.

Nome Tipo Descrição Obrigatório Predefinido
ferramentas permitidas objecto Não
└─ nomes_de_ferramentas matriz Lista de nomes de ferramentas permitidas. Não
cabeçalhos objecto Cabeçalhos HTTP opcionais para enviar ao servidor MCP. Uso para autenticação
ou outros fins.		 Não
requer_aprovação objeto (ver modelos válidos abaixo) Especifique quais das ferramentas do servidor MCP requerem aprovação. Não
rótulo de servidor cadeia (de caracteres) Um rótulo para este servidor MCP, usado para identificá-lo em chamadas de ferramentas. Yes
URL do servidor cadeia (de caracteres) A URL do servidor MCP. Yes
tipo enumeração O tipo da ferramenta MCP. Sempre mcp.
Valores possíveis: mcp		 Yes

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 em um formato estruturado e consultar objetos via API ou o painel.

As teclas 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 Predefinido
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não

OpenAI.Modelo

Descreve uma oferta de modelo OpenAI que pode ser usada com a API.

Nome Tipo Descrição Obrigatório Predefinido
criado número inteiro O carimbo de data/hora Unix (em segundos) quando o modelo foi criado. Yes
id cadeia (de caracteres) O identificador de modelo, que pode ser referenciado nos pontos de extremidade da API. Yes
objecto enumeração O tipo de objeto, que é sempre "modelo".
Valores possíveis: model		 Yes
owned_by cadeia (de caracteres) A organização proprietária do modelo. Yes

OpenAI.OtherChunkingStrategyResponseParam

Isso é retornado quando a estratégia de fragmentação é desconhecida. Normalmente, isso ocorre porque o arquivo foi indexado antes do chunking_strategy conceito ser introduzido na API.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração Sempre other.
Valores possíveis: other		 Yes

OpenAI.ParallelToolCalls

Se a chamada de função paralela deve ser ativada durante o uso da ferramenta.

Tipo: booleano

OpenAI.Prompt

Referência a um modelo de prompt e suas variáveis.

Nome Tipo Descrição Obrigatório Predefinido
id cadeia (de caracteres) O identificador exclusivo do modelo de prompt a ser usado. Yes
variables objecto Mapa opcional de valores para substituir variáveis em seu
prompt. Os valores de substituição podem ser strings ou outros
Tipos de entrada de resposta, como imagens ou arquivos.		 Não
versão cadeia (de caracteres) Versão opcional do modelo de prompt. Não

Opções de Classificação da OpenAI

Nome Tipo Descrição Obrigatório Predefinido
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 ficheiros, 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.Raciocínio

apenas modelos de raciocínio

Opções de configuração para modelos de raciocínio.

Nome Tipo Descrição Obrigatório Predefinido
esforço objecto apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
generate_summary enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
resumo enumeração Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não

OpenAI.EsforçoDeRaciocínio

apenas modelos de raciocínio

Restringe o esforço no raciocínio para modelos de raciocínio. Atualmente, os valores suportados são low, mediume high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

Propriedade Valor
Descrição apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.
Tipo cadeia (de caracteres)
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 na input API de respostas para turnos subsequentes de uma conversa se você estiver gerenciando manualmente o contexto.

Nome Tipo Descrição Obrigatório Predefinido
encrypted_content cadeia (de caracteres) O conteúdo criptografado do item de raciocínio - preenchido quando uma resposta é
gerado com reasoning.encrypted_content no include parâmetro.		 Não
resumo matriz Fundamentação do conteúdo do texto. Yes
tipo enumeração
Valores possíveis: reasoning		 Yes

OpenAI.ReasoningItemResource

Uma descrição da cadeia de pensamento usada por um modelo de raciocínio ao gerar uma resposta. Certifique-se de incluir esses itens na input API de respostas para turnos subsequentes de uma conversa se você estiver gerenciando manualmente o contexto.

Nome Tipo Descrição Obrigatório Predefinido
encrypted_content cadeia (de caracteres) O conteúdo criptografado do item de raciocínio - preenchido quando uma resposta é
gerado com reasoning.encrypted_content no include parâmetro.		 Não
resumo matriz Fundamentação do conteúdo do texto. Yes
tipo enumeração
Valores possíveis: reasoning		 Yes

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Valor do tipo Esquema
summary_text OpenAI.ReasoningItemSummaryTextPart
Nome Tipo Descrição Obrigatório Predefinido
tipo OpenAI.ReasoningItemSummaryPartType Yes

OpenAI.ReasoningItemSummaryPartType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores summary_text

OpenAI.ReasoningItemSummaryTextPart

Nome Tipo Descrição Obrigatório Predefinido
enviar SMS cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: summary_text		 Yes

OpenAI.Resposta

Nome Tipo Descrição Obrigatório Predefinido
em segundo plano Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
criado_em número inteiro Carimbo de data/hora Unix (em segundos) de quando esta resposta foi criada. Yes
erro objecto Um objeto de erro retornado quando o modelo não consegue gerar uma resposta. Yes
└─ código OpenAI.ResponseErrorCode O código de erro para a resposta. Não
└─ mensagem cadeia (de caracteres) Uma descrição do erro legível por humanos. Não
id cadeia (de caracteres) Identificador exclusivo para esta resposta. Yes
incomplete_details objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Yes
└─ Justificação enumeração A razão pela 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 número 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 número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
objecto enumeração O tipo de objeto deste recurso - sempre definido como response.
Valores possíveis: response		 Yes
output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Yes
output_text cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Yes Verdade
previous_response_id cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
avisar objecto Referência a um modelo de prompt e suas variáveis.
 Não
└─ ID cadeia (de caracteres) O identificador exclusivo do modelo de prompt a ser usado. Não
└─ variáveis OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis em seu
prompt. Os valores de substituição podem ser strings ou outros
Tipos de entrada de resposta, como imagens ou arquivos.		 Não
└─ versão cadeia (de caracteres) Versão opcional do modelo de prompt. Não
Fundamentação objecto apenas modelos de raciocínio

Opções de configuração para
modelos de raciocínio.		 Não
└─ esforço OpenAI.ReasoningEffort apenas modelos de raciocínio

Restringe o esforço de raciocínio para
modelos de raciocínio.
Atualmente, os valores suportados são low, mediume high. Reduzindo
O esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados
sobre o raciocínio numa resposta.		 Não
└─ gerar_resumo enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
└─ Resumo enumeração Um resumo do raciocínio realizado pelo modelo. Isto pode ser
útil para depurar e compreender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, concise, detailed		 Não
estado enumeração O status da geração de resposta. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Yes
enviar SMS objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto ou dados JSON estruturados. Saiba mais: Saídas estruturadas		 Não
└─ formato OpenAI.ResponseTextFormatConfiguration Não
tool_choice objecto Controla qual (se houver) ferramenta é 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Yes
truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Emitido quando um trecho de código parcial é transmitido pelo interpretador de código.

Nome Tipo Descrição Obrigatório Predefinido
delta cadeia (de caracteres) O trecho de código parcial sendo transmitido pelo interpretador de código. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta interpretadora de código. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número inteiro O índice do item de saída na resposta para a 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 trecho de código é finalizado pelo interpretador de código.

Nome Tipo Descrição Obrigatório Predefinido
código cadeia (de caracteres) A saída do trecho de código final pelo interpretador de código. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta interpretadora de código. Yes
output_index número 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 Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta interpretadora de código. Yes
output_index número 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 interpretador de código está em andamento.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta interpretadora de código. Yes
output_index número 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 interpretador de código está interpretando ativamente o trecho de código.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta interpretadora de código. Yes
output_index número inteiro O índice do item de saída na resposta para a qual o interpretador de código está interpretando 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 está completa.

Nome Tipo Descrição Obrigatório Predefinido
response objecto Yes
└─ Antecedentes Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
└─ created_at número 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 não consegue gerar uma resposta. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta. Não
└─ detalhes_incompletos objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Não
└─ Justificação enumeração A razão pela 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 utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
└─ max_output_tokens (limite máximo de tokens de saída) número 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
└─ número_máximo_de_chamadas_da_ferramenta número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ objeto enumeração O tipo de objeto deste 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 output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Não
└─ texto_de_saida cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
└─ chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
└─ ID_de_resposta_anterior cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
└─ Prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis.
 Não
└─ raciocínio OpenAI.Raciocínio apenas 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. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
└─ temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não
└─ texto objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto 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 tools parâmetro 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
└─ top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não
└─ truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
└─ utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
└─ utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar 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 Predefinido
content_index número inteiro O índice da parte de conteúdo que foi adicionada. Yes
item_id cadeia (de caracteres) A ID do item de saída ao qual a parte de conteúdo foi adicionada. Yes
output_index número inteiro O índice do item de saída ao qual a parte de conteúdo foi adicionada. Yes
parte objecto Yes
└─ tipo OpenAI.ItemContentType Conteúdos multimodais de entrada e saída. 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 Predefinido
content_index número inteiro O índice da parte de conteúdo que é feita. Yes
item_id cadeia (de caracteres) A ID do item de saída ao qual a parte de conteúdo foi adicionada. Yes
output_index número inteiro O índice do item de saída ao qual a parte de conteúdo foi adicionada. Yes
parte objecto Yes
└─ tipo OpenAI.ItemContentType Conteúdos multimodais de entrada e saída. 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 que é emitido quando uma resposta é criada.

Nome Tipo Descrição Obrigatório Predefinido
response objecto Yes
└─ Antecedentes Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
└─ created_at número 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 não consegue gerar uma resposta. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta. Não
└─ detalhes_incompletos objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Não
└─ Justificação enumeração A razão pela 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 utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
└─ max_output_tokens (limite máximo de tokens de saída) número 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
└─ número_máximo_de_chamadas_da_ferramenta número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ objeto enumeração O tipo de objeto deste 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 output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Não
└─ texto_de_saida cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
└─ chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
└─ ID_de_resposta_anterior cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
└─ Prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis.
 Não
└─ raciocínio OpenAI.Raciocínio apenas 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. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
└─ temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não
└─ texto objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto 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 tools parâmetro 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
└─ top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não
└─ truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
└─ utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
└─ utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar 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 não consegue gerar uma resposta.

Nome Tipo Descrição Obrigatório Predefinido
código OpenAI.ResponseErrorCode O código de erro para a resposta. Yes
mensagem cadeia (de caracteres) Uma descrição do erro legível por humanos. Yes

OpenAI.ResponseErrorCode

O código de erro para a resposta.

Propriedade Valor
Descrição O código de erro para a resposta.
Tipo cadeia (de caracteres)
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 Predefinido
código cadeia (de caracteres) O código de erro. Yes
mensagem cadeia (de caracteres) A mensagem de erro. Yes
param cadeia (de caracteres) O parâmetro error. Yes
tipo enumeração O tipo de evento. Sempre error.
Valores possíveis: error		 Yes

OpenAI.ResponseFailedEvent

Um evento que é emitido quando uma resposta falha.

Nome Tipo Descrição Obrigatório Predefinido
response objecto Yes
└─ Antecedentes Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
└─ created_at número 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 não consegue gerar uma resposta. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta. Não
└─ detalhes_incompletos objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Não
└─ Justificação enumeração A razão pela 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 utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
└─ max_output_tokens (limite máximo de tokens de saída) número 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
└─ número_máximo_de_chamadas_da_ferramenta número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ objeto enumeração O tipo de objeto deste 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 output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Não
└─ texto_de_saida cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
└─ chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
└─ ID_de_resposta_anterior cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
└─ Prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis.
 Não
└─ raciocínio OpenAI.Raciocínio apenas 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. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
└─ temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não
└─ texto objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto 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 tools parâmetro 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
└─ top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não
└─ truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
└─ utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
└─ utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar 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 Predefinido
item_id cadeia (de caracteres) A ID do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
output_index número 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 Predefinido
item_id cadeia (de caracteres) A ID do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
output_index número 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á sendo pesquisada no momento.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) A ID do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
output_index número 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

Este 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 Predefinido
tipo enumeração
Valores possíveis: text, json_object, json_schema		 Yes

OpenAI.ResponseFormatJsonObject

Formato de resposta de objeto JSON. Um método mais antigo de gerar respostas JSON. O uso json_schema é recomendado para modelos que o suportam. Observe que o modelo não gerará JSON sem uma mensagem do sistema ou do usuário instruindo-o a fazê-lo.

Nome Tipo Descrição Obrigatório Predefinido
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 do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Nome Tipo Descrição Obrigatório Predefinido
esquema_json objecto Opções de configuração de Saídas Estruturadas, incluindo um Esquema JSON. Yes
└─ Descrição cadeia (de caracteres) Uma descrição da finalidade do formato de resposta utilizada pelo modelo para
Determine como responder no formato.		 Não
└─ nome cadeia (de caracteres) 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 Booleano Se a adesão estrita ao esquema deve ser habilitada ao gerar a saída.
Se definido como true, o modelo sempre seguirá o esquema exato definido
no campo schema. Somente um subconjunto do esquema JSON é suportado quando
strict é true. Para saber mais, leia os Outputs estruturados
guia.		 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 Predefinido
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 parcial de argumentos de chamada de função.

Nome Tipo Descrição Obrigatório Predefinido
delta cadeia (de caracteres) Os argumentos de chamada de função delta que é adicionado. Yes
item_id cadeia (de caracteres) A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número inteiro O índice do item de saída ao qual os argumentos de chamada de função delta são adicionados. 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 Predefinido
arguments cadeia (de caracteres) Os argumentos de chamada de função. Yes
item_id cadeia (de caracteres) A ID do item. Yes
output_index número 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 Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index número 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 Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index número 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.gerando'.
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 Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index número 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.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 Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index número inteiro O índice do item de saída na matriz de saída da resposta. Yes
partial_image_b64 cadeia (de caracteres) Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem. Yes
partial_image_index número inteiro índice baseado em 0 para a imagem parcial (back-end é baseado em 1, mas este é 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 Predefinido
response objecto Yes
└─ Antecedentes Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
└─ created_at número 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 não consegue gerar uma resposta. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta. Não
└─ detalhes_incompletos objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Não
└─ Justificação enumeração A razão pela 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 utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
└─ max_output_tokens (limite máximo de tokens de saída) número 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
└─ número_máximo_de_chamadas_da_ferramenta número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ objeto enumeração O tipo de objeto deste 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 output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Não
└─ texto_de_saida cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
└─ chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
└─ ID_de_resposta_anterior cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
└─ Prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis.
 Não
└─ raciocínio OpenAI.Raciocínio apenas 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. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
└─ temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não
└─ texto objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto 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 tools parâmetro 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
└─ top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não
└─ truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
└─ utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
└─ utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar 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 que é emitido quando uma resposta termina como incompleta.

Nome Tipo Descrição Obrigatório Predefinido
response objecto Yes
└─ Antecedentes Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
└─ created_at número 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 não consegue gerar uma resposta. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta. Não
└─ detalhes_incompletos objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Não
└─ Justificação enumeração A razão pela 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 utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
└─ max_output_tokens (limite máximo de tokens de saída) número 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
└─ número_máximo_de_chamadas_da_ferramenta número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ objeto enumeração O tipo de objeto deste 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 output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Não
└─ texto_de_saida cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
└─ chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
└─ ID_de_resposta_anterior cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
└─ Prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis.
 Não
└─ raciocínio OpenAI.Raciocínio apenas 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. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
└─ temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não
└─ texto objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto 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 tools parâmetro 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
└─ top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não
└─ truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
└─ utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
└─ utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar 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 Predefinido
dados matriz Uma lista de itens usados para gerar essa resposta. Yes
first_id cadeia (de caracteres) A ID do primeiro item da lista. Yes
tem_mais Booleano Se há mais itens disponíveis. Yes
last_id cadeia (de caracteres) A ID do último item da lista. Yes
objecto 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 Predefinido
delta A atualização parcial dos argumentos para a chamada da ferramenta MCP. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número 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 para uma chamada de ferramenta MCP são finalizados.

Nome Tipo Descrição Obrigatório Predefinido
arguments Os argumentos finalizados para a chamada da ferramenta MCP. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado. Yes
output_index número 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 foi concluída com êxito.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo de evento. Sempre 'response.mcp_call.completed'.
Valores possíveis: response.mcp_call.completed		 Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falhou.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo de evento. Sempre 'response.mcp_call.failed'.
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 Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado. Yes
output_index número 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.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 êxito.

Nome Tipo Descrição Obrigatório Predefinido
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 Predefinido
tipo enumeração O tipo de evento. Sempre 'response.mcp_list_tools.failed'.
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 Predefinido
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 Predefinido
item objecto Item de conteúdo usado para gerar uma resposta. Yes
└─ ID cadeia (de caracteres) Não
└─ tipo OpenAI.ItemType Não
output_index número 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 Predefinido
item objecto Item de conteúdo usado para gerar uma resposta. Yes
└─ ID cadeia (de caracteres) Não
└─ tipo OpenAI.ItemType Não
output_index número 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 para substituir variáveis em 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 está na fila e aguardando para ser processada.

Nome Tipo Descrição Obrigatório Predefinido
response objecto Yes
└─ Antecedentes Booleano Se a resposta do modelo deve ser executada em segundo plano.
Mais informações.		 Não Falso
└─ created_at número 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 não consegue gerar uma resposta. Não
└─ ID cadeia (de caracteres) Identificador exclusivo para esta resposta. Não
└─ detalhes_incompletos objecto Detalhes sobre o motivo pelo qual a resposta está incompleta. Não
└─ Justificação enumeração A razão pela 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 utilizar juntamente com previous_response_ido , as instruções de um
a resposta não será transferida para a resposta seguinte. Isso simplifica
para trocar mensagens do sistema (ou desenvolvedor) em novas respostas.		 Não
└─ max_output_tokens (limite máximo de tokens de saída) número 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
└─ número_máximo_de_chamadas_da_ferramenta número inteiro O número máximo de chamadas totais para ferramentas integradas que podem ser processadas em uma resposta. Este número máximo aplica-se a todas as chamadas de ferramentas incorporadas, não por ferramenta individual. Quaisquer outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. Não
└─ metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
└─ objeto enumeração O tipo de objeto deste 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 output ordem dos itens na matriz dependem
na resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e
assumindo que é uma assistant mensagem com o conteúdo gerado por
o modelo, você pode considerar usar a output_text propriedade onde
suportado em SDKs.		 Não
└─ texto_de_saida cadeia (de caracteres) Propriedade de conveniência somente SDK que contém a saída de texto agregado
de todos os output_text itens na output matriz, se algum estiver presente.
Suportado nos SDKs Python e JavaScript.		 Não
└─ chamadas_de_ferramentas_em_paralelo Booleano Se deve permitir que o modelo execute chamadas de ferramenta em paralelo. Não Verdade
└─ ID_de_resposta_anterior cadeia (de caracteres) O ID exclusivo da resposta anterior ao modelo. Utilize esta opção para
Crie conversas em vários turnos.		 Não
└─ Prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis.
 Não
└─ raciocínio OpenAI.Raciocínio apenas 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. Um dos completed, failed,
in_progress, cancelled, queued ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, , queued, incomplete		 Não
└─ temperatura número Qual a temperatura de amostragem a utilizar, 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 ambos.		 Não
└─ texto objecto Opções de configuração para uma resposta de texto do modelo. Pode ser simples
texto 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 tools parâmetro 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 tool_choice parâmetro.

As duas categorias de ferramentas que você pode fornecer ao modelo são:

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem o
recursos do modelo, como pesquisa na Web ou pesquisa de arquivos.		 Não
└─ top_logprobs número inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis de retornar 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,
onde o modelo considera os resultados dos tokens com top_p probabilidade
massa. Assim, 0,1 significa apenas os tokens que compõem os 10 primeiros% massa de probabilidade
são considerados.

Geralmente, recomendamos alterar isso ou temperature mas não ambos.		 Não
└─ truncamento enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: Se o contexto desta resposta e das anteriores exceder
o tamanho da janela de contexto do modelo, o modelo truncará o
para se ajustar à janela de contexto, descartando itens de entrada na
no meio da conversa.
- disabled (padrão): se uma resposta do modelo exceder a janela de contexto
tamanho para um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 Não
└─ utilização OpenAI.ResponseUsage Representa detalhes de uso de token, incluindo tokens de entrada, tokens de saída,
um detalhamento dos tokens de saída e o total de tokens usados.		 Não
└─ utilizador cadeia (de caracteres) Um identificador exclusivo que representa seu usuário final, que pode ajudar a OpenAI a monitorar e detetar abusos. Não
tipo enumeração O tipo de evento. Sempre 'response.queued'.
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 Predefinido
content_index número inteiro O índice da parte de conteúdo de raciocínio dentro do item de saída. Yes
delta A atualização parcial do conteúdo do raciocínio. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item para o qual o raciocínio está sendo atualizado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número 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 de raciocínio é finalizado para um item.

Nome Tipo Descrição Obrigatório Predefinido
content_index número inteiro O índice da parte de conteúdo de raciocínio dentro do item de saída. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item para o qual o raciocínio é finalizado. Yes
output_index número inteiro O índice do item de saída na matriz de saída da resposta. Yes
enviar SMS cadeia (de caracteres) 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 do resumo de raciocínio.

Nome Tipo Descrição Obrigatório Predefinido
delta A atualização parcial do conteúdo do resumo de fundamentação. Yes
item_id cadeia (de caracteres) O identificador exclusivo do item para o qual o resumo de raciocínio está sendo atualizado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número inteiro O índice do item de saída na matriz de saída da resposta. Yes
summary_index número 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 de raciocínio é finalizado para um item.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) O identificador exclusivo do item para o qual o resumo de raciocínio é finalizado. Yes
output_index número inteiro O índice do item de saída na matriz de saída da resposta. Yes
summary_index número inteiro O índice da parte de resumo dentro do item de saída. Yes
enviar SMS cadeia (de caracteres) O texto resumido do raciocínio finalizado. Yes
tipo enumeração O tipo de evento. Sempre 'response.reasoning_summary.done'.
Valores possíveis: response.reasoning_summary.done		 Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Emitido quando é adicionada uma nova parte do resumo do raciocínio.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) A ID do item ao qual esta parte de resumo está associada. Yes
output_index número inteiro O índice do item de saída ao qual esta parte de resumo está associada. Yes
parte objecto Yes
└─ tipo OpenAI.ReasoningItemSummaryPartType Não
summary_index número inteiro O índice da parte sumária dentro da exposição de motivos. 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 sumária de raciocínio é concluída.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) A ID do item ao qual esta parte de resumo está associada. Yes
output_index número inteiro O índice do item de saída ao qual esta parte de resumo está associada. Yes
parte objecto Yes
└─ tipo OpenAI.ReasoningItemSummaryPartType Não
summary_index número inteiro O índice da parte sumária dentro da exposição de motivos. 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 Predefinido
delta cadeia (de caracteres) O texto delta que foi adicionado ao resumo. Yes
item_id cadeia (de caracteres) A ID do item ao qual este delta de texto de resumo está associado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número inteiro O índice do item de saída ao qual este delta de texto de resumo está associado. Yes
summary_index número inteiro O índice da parte sumária dentro da exposição de motivos. 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 Predefinido
item_id cadeia (de caracteres) A ID do item ao qual este texto de resumo está associado. Yes
output_index número inteiro O índice do item de saída ao qual este texto de resumo está associado. Yes
summary_index número inteiro O índice da parte sumária dentro da exposição de motivos. Yes
enviar SMS cadeia (de caracteres) Texto integral da exposição de motivos completa. 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 Predefinido
content_index número inteiro O índice da parte de conteúdo à qual o texto de recusa é adicionado. Yes
delta cadeia (de caracteres) O texto de recusa que é adicionado. Yes
item_id cadeia (de caracteres) A ID do item de saída ao qual o texto de recusa é adicionado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número 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 Predefinido
content_index número inteiro O índice da parte de conteúdo que o texto de recusa é finalizado. Yes
item_id cadeia (de caracteres) A ID do item de saída que o texto de recusa é finalizado. Yes
output_index número inteiro O índice do item de saída que o texto de recusa é finalizado. Yes
recusa cadeia (de caracteres) O texto de recusa que está 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

Este 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 Predefinido
sequence_number número inteiro O número de sequência para este evento. Yes
tipo OpenAI.ResponseStreamEventType Yes

OpenAI.ResponseStreamEventType

Propriedade Valor
Tipo cadeia (de caracteres)
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 Predefinido
content_index número inteiro O índice da parte de conteúdo à qual o delta de texto foi adicionado. Yes
delta cadeia (de caracteres) O texto delta que foi adicionado. Yes
item_id cadeia (de caracteres) A ID do item de saída ao qual o delta de texto foi adicionado. Yes
ofuscação cadeia (de caracteres) Um campo de caracteres aleatórios introduzidos por ofuscação de fluxo. A ofuscação de fluxo é um mecanismo que atenua certos ataques de canal lateral. Yes
output_index número 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 Predefinido
content_index número inteiro O índice da parte de conteúdo que o conteúdo de texto é finalizado. Yes
item_id cadeia (de caracteres) A ID do item de saída que o conteúdo de texto é finalizado. Yes
output_index número inteiro O índice do item de saída que o conteúdo do texto é finalizado. Yes
enviar SMS cadeia (de caracteres) O conteúdo do texto que é finalizado. Yes
tipo enumeração O tipo de evento. Sempre response.output_text.done.
Valores possíveis: response.output_text.done		 Yes

Configuração do formato de texto da resposta OpenAI (OpenAI.ResponseTextFormatConfiguration)

Discriminador para Configuração do Formato de Texto de Resposta do OpenAI

Este 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 Predefinido
tipo OpenAI.TipoDeConfiguraçãoDeFormatoDeTextoDeResposta Um objeto que especifica o formato que o modelo deve produzir.

A configuração { "type": "json_schema" } permite saídas estruturadas,
o que garante que o modelo corresponderá 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 gpt-4o e modelos mais recentes:

Definir para { "type": "json_object" } ativa o modo JSON mais antigo, que
garante que a mensagem que o modelo gera é JSON válida. Usando json_schema
é preferível para modelos que o suportem.		 Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração
Valores possíveis: json_object		 Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema (esquema de configuração de formato de texto)

Formato de resposta do esquema JSON. Usado para gerar respostas JSON estruturadas. Saiba mais sobre Saídas Estruturadas.

Nome Tipo Descrição Obrigatório Predefinido
descrição cadeia (de caracteres) Uma descrição da finalidade do formato de resposta utilizada pelo modelo para
Determine como responder no formato.		 Não
nome cadeia (de caracteres) 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 Booleano Se a adesão estrita ao esquema deve ser habilitada ao gerar a saída.
Se definido como true, o modelo sempre seguirá o esquema exato definido
no campo schema. Somente um subconjunto do esquema JSON é suportado quando
strict é true. Para saber mais, leia os Outputs estruturados
guia.		 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

Configuração do Formato do Texto de Resposta do OpenAI

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

OpenAI.ResponseTextFormatConfigurationType

Um objeto que especifica o formato que o modelo deve produzir.

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 Saídas estruturadas.

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para gpt-4o e modelos mais recentes:

Configurar para { "type": "json_object" } ativa o modo JSON antigo, o que garante que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferível para modelos que o suportam.

Propriedade Valor
Descrição Um objeto que especifica o formato que o modelo deve produzir.

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 Saídas estruturadas.

O formato padrão é { "type": "text" } sem opções adicionais.

Não recomendado para gpt-4o e modelos mais recentes:

Configurar para { "type": "json_object" } ativa o modo JSON antigo, o que garante que a mensagem gerada pelo modelo seja JSON válido. O uso json_schema é preferível para modelos que o suportam. | | Tipo | string | | Valores | text
json_schema
json_object |

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 Predefinido
input_tokens número inteiro O número de tokens de entrada. Yes
input_tokens_details objecto Um detalhamento detalhado dos tokens de entrada. Yes
└─ tokens em cache número inteiro O número de tokens que foram recuperados do cache.
Saiba mais sobre o cache de prompts.		 Não
output_tokens número inteiro O número de tokens de saída. Yes
output_tokens_details objecto Um detalhamento detalhado dos tokens de saída. Yes
└─ tokens de raciocínio número inteiro O número de tokens de raciocínio. Não
total_tokens número inteiro O número total de tokens usados. Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Observação

web_search ainda não está disponível através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) ID exclusivo para o item de saída associado à chamada de pesquisa na Web. Yes
output_index número 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 através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) ID exclusivo para o item de saída associado à chamada de pesquisa na Web. Yes
output_index número 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 através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
item_id cadeia (de caracteres) ID exclusivo para o item de saída associado à chamada de pesquisa na Web. Yes
output_index número 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 assistant função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre assistant.
Valores possíveis: assistant		 Yes

OpenAI.ResponsesAssistantMessageItemResource

Um item de recurso de mensagem com a assistant função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre assistant.
Valores possíveis: assistant		 Yes

OpenAI.ResponsesDeveloperMessageItemParam

Um item de parâmetro de mensagem com a developer função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre developer.
Valores possíveis: developer		 Yes

OpenAI.ResponsesDeveloperMessageItemResource

Um item de recurso de mensagem com a developer função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre developer.
Valores possíveis: developer		 Yes

OpenAI.ResponsesMessageItemParam

Um item de mensagem de resposta, representando uma função e conteúdo, conforme fornecido como parâmetros de solicitação do cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

Este 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 Predefinido
função objecto A coleção de funções válidas para itens de mensagem de resposta. 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, representando uma função e conteúdo, conforme fornecido nas respostas do serviço.

Discriminador para OpenAI.ResponsesMessageItemResource

Este 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 Predefinido
função objecto A coleção de funções válidas para itens de mensagem de resposta. Yes
estado enumeração O status do item. Um dos in_progress, completed, ou
incomplete. Preenchido quando os itens são retornados via API.
Valores possíveis: in_progress, completed, incomplete		 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 resposta.

Propriedade Valor
Descrição A coleção de funções válidas para itens de mensagem de resposta.
Tipo cadeia (de caracteres)
Valores system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

Um item de parâmetro de mensagem com a system função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre system.
Valores possíveis: system		 Yes

OpenAI.ResponsesSystemMessageItemResource

Um item de recurso de mensagem com a system função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre system.
Valores possíveis: system		 Yes

OpenAI.ResponsesUserMessageItemParam

Um item de parâmetro de mensagem com a user função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre user.
Valores possíveis: user		 Yes

OpenAI.ResponsesUserMessageItemResource

Um item de recurso de mensagem com a user função.

Nome Tipo Descrição Obrigatório Predefinido
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração O papel da mensagem, que é sempre user.
Valores possíveis: user		 Yes

OpenAI.RunGraderRequest

Nome Tipo Descrição Obrigatório Predefinido
Motoniveladora objecto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calcular_saída cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Não
└─ métrica_de_avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Não
└─ Motoniveladoras objecto Não
└─ tag de imagem cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
└─ entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Não
└─ modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Não
└─ nome cadeia (de caracteres) O nome do classificador. Não
└─ operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Não
└─ gama matriz O intervalo da pontuação. O padrão é [0, 1]. Não
└─ referência cadeia (de caracteres) O texto que está a ser avaliado. Não
└─ parâmetros_de_amostragem Os parâmetros de amostragem para o modelo. Não
└─ fonte cadeia (de caracteres) 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 do conjunto de dados fornecido ao classificador. Isso será usado para preencher
o item namespace. Consulte o guia para obter mais detalhes.		 Não
model_sample cadeia (de caracteres) A amostra modelo a ser avaliada. Esse valor será usado para preencher
o sample namespace. Consulte o guia para obter mais detalhes.
A output_json variável será preenchida se a amostra do modelo for um
cadeia de caracteres JSON válida.		 Yes

OpenAI.RunGraderResponse

Nome Tipo Descrição Obrigatório Predefinido
metadados objecto Yes
└─ erros objecto Não
└─ erro_de_análise_de_fórmula Booleano Não
└─ invalid_variable_error (erro de variável inválida) Booleano Não
└─ erro_de_análise_do_modelo_grader Booleano Não
└─ model_grader_refusal_error (erro de recusa do avaliador de modelo) Booleano Não
└─ erro_servidor_avaliador_modelo Booleano Não
└─ detalhes_do_erro_do_servidor_modelo_grader cadeia (de caracteres) Não
└─ outro_erro Booleano Não
└─ erro_de_execução_python_grader Booleano Não
└─ detalhes_erro_execução_python_grader cadeia (de caracteres) Não
└─ erro_do_servidor_grader_python Booleano Não
└─ python_avaliador_tipo_de_erro_do_servidor cadeia (de caracteres) Não
└─ erro_de_análise_de_amostra Booleano Não
└─ erro_de_observação_truncada Booleano Não
└─ erro_recompensa_não_responsivo Booleano Não
└─ tempo_de_execução número Não
└─ nome cadeia (de caracteres) Não
└─ nome_do_modelo_amostrado cadeia (de caracteres) Não
└─ pontuações Não
└─ utilização_de_token número inteiro Não
└─ tipo cadeia (de caracteres) Não
model_grader_token_usage_per_model Yes
recompensa número Yes
sub_rewards Yes

OpenAI.StaticChunkingEstratégia

Nome Tipo Descrição Obrigatório Predefinido
chunk_overlap_tokens número inteiro O número de tokens que se sobrepõem entre partes. O valor predefinido é 400.

Observe que a sobreposição não deve exceder metade de max_chunk_size_tokens.		 Yes
max_chunk_size_tokens número inteiro O número máximo de tokens em cada bloco. O valor predefinido é 800. O valor mínimo é 100 e o valor máximo é 4096. Yes

OpenAI.StaticChunkingStrategyRequestParam

Personalize sua própria estratégia de fragmentação definindo o tamanho do bloco e a sobreposição do bloco.

Nome Tipo Descrição Obrigatório Predefinido
estático OpenAI.StaticChunkingEstratégia Yes
tipo enumeração Sempre static.
Valores possíveis: static		 Yes

OpenAI.StaticChunkingStrategyResponseParam

Nome Tipo Descrição Obrigatório Predefinido
estático OpenAI.StaticChunkingEstratégia Yes
tipo enumeração Sempre static.
Valores possíveis: static		 Yes

OpenAI.StopConfiguration

Não suportado com os modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências onde a API deixará de gerar mais tokens. O texto retornado não conterá a sequência de parada.

Este esquema aceita um dos seguintes tipos:

  • string
  • matriz

OpenAI.Tool

Discriminador para OpenAI.Tool

Este 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 Predefinido
tipo OpenAI.ToolType Uma ferramenta que pode ser usada para gerar uma resposta. Yes

OpenAI.ToolChoiceObject

Discriminador para OpenAI.ToolChoiceObject

Este 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 Predefinido
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 Predefinido
tipo enumeração
Valores possíveis: code_interpreter		 Yes

OpenAI.ToolChoiceObjectComputer

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração
Valores possíveis: computer_use_preview		 Yes

OpenAI.ToolChoiceObjectFileSearch

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração
Valores possíveis: file_search		 Yes

OpenAI.ToolChoiceObjectFunction

Use esta opção para forçar o modelo a chamar uma função específica.

Nome Tipo Descrição Obrigatório Predefinido
nome cadeia (de caracteres) O nome da função a ser chamada. Yes
tipo enumeração Para chamada de função, o tipo é sempre function.
Valores possíveis: function		 Yes

OpenAI.ToolChoiceObjectImageGen

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração
Valores possíveis: image_generation		 Yes

OpenAI.ToolChoiceObjectMCP

Use esta opção para forçar o modelo a chamar uma ferramenta específica em um servidor MCP remoto.

Nome Tipo Descrição Obrigatório Predefinido
nome cadeia (de caracteres) O nome da ferramenta a ser chamada no servidor. Não
rótulo de servidor cadeia (de caracteres) O rótulo do servidor MCP a ser usado. Yes
tipo enumeração Para ferramentas MCP, o tipo é 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 (de caracteres)
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 através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração
Valores possíveis: web_search_preview		 Yes

OpenAI.ToolChoiceOptions

Controla qual (se houver) ferramenta é 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 (se houver) ferramenta é 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 (de caracteres)
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 (de caracteres)
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 Descrição Obrigatório Predefinido
bytes matriz Yes
Logprob número Yes
token cadeia (de caracteres) Yes

OpenAI.UpdateVectorStoreFileAttributesRequest

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Yes

OpenAI.UpdateVectorStoreRequest

Nome Tipo Descrição Obrigatório Predefinido
expira após objecto A política de expiração para um repositório de vetores. Não
└─ âncora enumeração Carimbo de data/hora âncora após o qual a política de expiração se aplica. Âncoras suportadas: last_active_at.
Valores possíveis: last_active_at		 Não
└─ dias número inteiro O número de dias após o tempo de ancoragem que o armazenamento do vetor expirará. Não
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Não
nome cadeia (de caracteres) O nome do repositório de vetores. Não

OpenAI.ValidateGraderRequest

Nome Tipo Descrição Obrigatório Predefinido
Motoniveladora objecto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calcular_saída cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Não
└─ métrica_de_avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Não
└─ Motoniveladoras objecto Não
└─ tag de imagem cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
└─ entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Não
└─ modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Não
└─ nome cadeia (de caracteres) O nome do classificador. Não
└─ operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Não
└─ gama matriz O intervalo da pontuação. O padrão é [0, 1]. Não
└─ referência cadeia (de caracteres) O texto que está a ser avaliado. Não
└─ parâmetros_de_amostragem Os parâmetros de amostragem para o modelo. Não
└─ fonte cadeia (de caracteres) 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 Predefinido
Motoniveladora objecto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Não
└─ calcular_saída cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados da série. Não
└─ métrica_de_avaliação enumeração A métrica de avaliação a ser usada. Um dos fuzzy_match, bleu, gleu, , meteor, rouge_1, rouge_2, rouge_3rouge_4, rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, rouge_l		 Não
└─ Motoniveladoras objecto Não
└─ tag de imagem cadeia (de caracteres) A tag de imagem a ser usada para o script python. Não
└─ entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Não
└─ modelo cadeia (de caracteres) O modelo a utilizar para a avaliação. Não
└─ nome cadeia (de caracteres) O nome do classificador. Não
└─ operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Não
└─ gama matriz O intervalo da pontuação. O padrão é [0, 1]. Não
└─ referência cadeia (de caracteres) O texto que está a ser avaliado. Não
└─ parâmetros_de_amostragem Os parâmetros de amostragem para o modelo. Não
└─ fonte cadeia (de caracteres) 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 para um repositório de vetores.

Nome Tipo Descrição Obrigatório Predefinido
âncora enumeração Carimbo de data/hora âncora após o qual a política de expiração se aplica. Âncoras suportadas: last_active_at.
Valores possíveis: last_active_at		 Yes
Dias número inteiro O número de dias após o tempo de ancoragem que o armazenamento do vetor 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 via API ou o painel. As teclas 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, booleanos ou números.

Tipo: objeto

OpenAI.VectorStoreFileBatchObject

Um lote de arquivos anexados a um armazenamento vetorial.

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro O carimbo de data/hora Unix (em segundos) para quando o lote de arquivos de armazenamento vetorial foi criado. Yes
file_counts objecto Yes
└─ Cancelado número inteiro O número de arquivos que foram cancelados. Não
└─ concluída número inteiro O número de arquivos que foram processados. Não
└─ não conseguiu número inteiro O número de arquivos que não conseguiram processar. Não
└─ em progresso número inteiro O número de arquivos que estão sendo processados no momento. Não
└─ total número inteiro O número total de ficheiros. Não
id cadeia (de caracteres) O identificador, que pode ser referenciado em pontos de extremidade de API. Yes
objecto enumeração O tipo de objeto, que é sempre vector_store.file_batch.
Valores possíveis: vector_store.files_batch		 Yes
estado enumeração O status do lote de arquivos de armazenamento vetorial, que pode ser in_progress, completedcancelled ou failed.
Valores possíveis: in_progress, completed, cancelled, failed		 Yes
vector_store_id cadeia (de caracteres) A ID do armazenamento vetorial ao qual o arquivo está anexado. Yes

OpenAI.VectorStoreFileObject

Uma lista de arquivos anexados a um repositório vetorial.

Nome Tipo Descrição Obrigatório Predefinido
attributes objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo. As teclas são strings
com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um máximo de
comprimento de 512 caracteres, booleanos ou números.		 Não
chunking_strategy objecto Não
└─ tipo enumeração
Valores possíveis: static, other		 Não
criado_em número inteiro O carimbo de data/hora Unix (em segundos) para quando o arquivo de armazenamento vetorial foi criado. Yes
id cadeia (de caracteres) O identificador, que pode ser referenciado em pontos de extremidade de API. Yes
last_error objecto O último erro associado a este arquivo de armazenamento vetorial. Será null se não houver erros. Yes
└─ código enumeração Um dos server_error ou rate_limit_exceeded.
Valores possíveis: server_error, unsupported_file, invalid_file		 Não
└─ mensagem cadeia (de caracteres) Uma descrição do erro legível por humanos. Não
objecto enumeração O tipo de objeto, que é sempre vector_store.file.
Valores possíveis: vector_store.file		 Yes
estado enumeração O status do arquivo de armazenamento vetorial, que pode ser in_progress, completed, cancelled, ou failed. O status completed indica que o arquivo de armazenamento vetorial está pronto para uso.
Valores possíveis: in_progress, completed, cancelled, failed		 Yes
usage_bytes número inteiro O uso total do armazenamento de vetores em bytes. Observe que isso pode ser diferente do tamanho do arquivo original. Yes
vector_store_id cadeia (de caracteres) A ID do armazenamento vetorial ao qual o arquivo está anexado. Yes

OpenAI.VectorStoreObject

Um armazenamento vetorial é uma coleção de arquivos processados que podem ser usados pela file_search ferramenta.

Nome Tipo Descrição Obrigatório Predefinido
criado_em número inteiro O carimbo de data/hora Unix (em segundos) para quando o armazenamento vetorial foi criado. Yes
expira após OpenAI.VectorStoreExpirationAfter A política de expiração para um repositório de vetores. Não
expira_em número inteiro O carimbo de data/hora do Unix (em segundos) para quando o armazenamento vetorial expirará. Não
file_counts objecto Yes
└─ Cancelado número inteiro O número de arquivos que foram cancelados. Não
└─ concluída número inteiro O número de arquivos que foram processados com êxito. Não
└─ não conseguiu número inteiro O número de arquivos que não conseguiram processar. Não
└─ em progresso número inteiro O número de arquivos que estão sendo processados no momento. Não
└─ total número inteiro O número total de ficheiros. Não
id cadeia (de caracteres) O identificador, que pode ser referenciado em pontos de extremidade de API. Yes
last_active_at número inteiro O carimbo de data/hora Unix (em segundos) para quando o armazenamento vetorial foi ativo pela última vez. Yes
metadados objecto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isto pode ser
útil para armazenar informações adicionais sobre o objeto de forma estruturada
formato e consulta de objetos via API ou painel de controlo.

As teclas 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.		 Yes
nome cadeia (de caracteres) O nome do repositório de vetores. Yes
objecto enumeração O tipo de objeto, que é sempre vector_store.
Valores possíveis: vector_store		 Yes
estado enumeração O status do armazenamento vetorial, que pode ser , expiredin_progressou completed. Um status de indica que o armazenamento de completed vetores está pronto para uso.
Valores possíveis: expired, in_progress, completed		 Yes
usage_bytes número inteiro O número total de bytes usados pelos arquivos no armazenamento vetorial. Yes

OpenAI.VoiceIdsShared

Propriedade Valor
Tipo cadeia (de caracteres)
Valores alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Valor do tipo Esquema
find OpenAI.WebSearchActionLocalizar
open_page OpenAI.WebSearchAçãoOpenPage
search OpenAI.WebSearchActionSearch
Nome Tipo Descrição Obrigatório Predefinido
tipo OpenAI.WebSearchActionType Yes

OpenAI.WebSearchActionLocalizar

Tipo de ação "localizar": procura um padrão dentro de uma página carregada.

Nome Tipo Descrição Obrigatório Predefinido
padrão cadeia (de caracteres) O padrão ou texto a ser pesquisado dentro da página. Yes
tipo enumeração O tipo de ação.
Valores possíveis: find		 Yes
URL cadeia (de caracteres) O URL da página pesquisou o padrão. Yes

OpenAI.WebSearchAçãoOpenPage

Tipo de ação "open_page" - Abre um URL específico dos resultados da pesquisa.

Nome Tipo Descrição Obrigatório Predefinido
tipo enumeração O tipo de ação.
Valores possíveis: open_page		 Yes
URL cadeia (de caracteres) O URL aberto pelo modelo. Yes

OpenAI.WebSearchActionSearch

Tipo de ação "pesquisar" - Executa uma consulta de pesquisa na Web.

Nome Tipo Descrição Obrigatório Predefinido
consulta cadeia (de caracteres) A consulta de pesquisa. Yes
tipo enumeração O tipo de ação.
Valores possíveis: search		 Yes

OpenAI.WebSearchActionType

Propriedade Valor
Tipo cadeia (de caracteres)
Valores search
open_page
find

OpenAI.WebSearchPreviewTool

Observação

web_search ainda não está disponível através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
tamanho_do_contexto_de_pesquisa enumeração Orientação de alto nível para a quantidade de espaço na janela de contexto a ser usada para a pesquisa. Um de low, mediumou high. medium é o padrão.
Valores possíveis: low, medium, high		 Não
tipo enumeração O tipo da ferramenta de pesquisa na Web. Um dos web_search_preview ou web_search_preview_2025_03_11.
Valores possíveis: web_search_preview		 Yes
localização_do_utilizador objecto Não
└─ tipo OpenAI.LocationType Não

OpenAI.WebSearchToolCallItemParam

Observação

web_search ainda não está disponível através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
ação objecto 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 através do Azure OpenAI.

Nome Tipo Descrição Obrigatório Predefinido
ação objecto Yes
└─ tipo OpenAI.WebSearchActionType Não
estado enumeração O status da chamada da ferramenta de pesquisa na web.
Valores possíveis: in_progress, searching, completed, failed		 Yes
tipo enumeração
Valores possíveis: web_search_call		 Yes

PineconeChatDataSource

Nome Tipo Descrição Obrigatório Predefinido
parâmetros objecto As informações do parâmetro para controlar o uso da fonte de dados Pinecone. Yes
└─ permitir_resultado_parcial Booleano Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todos os
as consultas parciais falham. Se não for especificado ou especificado como false, a solicitação falhará se qualquer consulta de pesquisa falhar.		 Não Falso
└─ autenticação objecto Não
└─ chave cadeia (de caracteres) Não
└─ tipo enumeração
Valores possíveis: api_key		 Não
└─ dependência_de_incorporação objecto Uma representação de uma fonte de vetorização de dados utilizável como um recurso de incorporação com uma fonte de dados. Não
└─ tipo AzureChatDataSourceVectorizationSourceType O identificador diferenciador para a fonte de vetorização do concreto. Não
└─ ambiente cadeia (de caracteres) O nome do ambiente a ser usado com Pinecone. Não
└─ mapeamento de campos objecto Mapeamentos de campo a serem aplicados aos dados usados pela fonte de dados Pinecone.
Observe que os mapeamentos de campo de conteúdo são necessários para Pinecone.		 Não
└─ campos_de_conteúdo matriz Não
└─ separador_de_campos_de_conteúdo cadeia (de caracteres) Não
└─ campo_caminho_ficheiro cadeia (de caracteres) Não
└─ campo_título cadeia (de caracteres) Não
└─ campo_URL cadeia (de caracteres) Não
└─ in_scope Booleano 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, serão solicitadas citações e intenção.		 Não ['citações', 'intenção']
└─ nome_do_índice cadeia (de caracteres) O nome do índice do banco de dados Pinecone a ser usado. Não
└─ consultas_de_pesquisa_máximas número 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
└─ rigor número inteiro O rigor configurado da filtragem de relevância da pesquisa.
Um maior rigor aumentará a precisão, mas menor recordação da resposta.		 Não
└─ top_n_documents número inteiro O número configurado de documentos a serem apresentados na consulta. Não
tipo enumeração O identificador de tipo discriminado, que é sempre "pinha".
Valores possíveis: pinecone		 Yes

ResponseFormatJSONSchemaRequest

Nome Tipo Descrição Obrigatório Predefinido
esquema_json objecto Esquema JSON para o formato de resposta Yes
tipo enumeração Tipo de formato de resposta
Valores possíveis: json_schema		 Yes

Modalidades de resposta

Tipos de saída que você gostaria que o modelo gerasse. A maioria dos modelos são capazes de gerar texto, que é o padrão:

["text"]

O gpt-4o-audio-preview modelo também pode ser usado para gerar áudio. Para solicitar que esse modelo gere respostas de texto e áudio, você pode usar:

["text", "audio"]

Matriz de: string

  • Last updated on