Azure OpenAI nos Modelos da Foundry da Microsoft API REST v1 em referência de pré-visualização

Este artigo fornece detalhes sobre os endpoints da API REST de inferência para o Azure OpenAI.

Inferência do plano de dados

O restante do artigo aborda a nossa nova versão 1 de pré-visualização da API da especificação de inferência do plano de dados do Azure OpenAI. Saiba mais no nosso guia do ciclo de vida da API.

Se procura documentação sobre a última versão da API GA v1, consulte a mais recente API de inferência de planos de dados GA

Create speech

POST {endpoint}/openai/v1/audio/speech?api-version=preview

Gera áudio de texto para voz a partir do texto de entrada.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API do Microsoft Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
dados introduzidos cadeia (de caracteres) O texto para gerar áudio. O comprimento máximo é de 4096 caracteres. Yes
instructions cadeia (de caracteres) Controla a voz do áudio gerado com instruções adicionais. Não funciona com tts-1 ou tts-1-hd. No
modelo cadeia (de caracteres) O modelo a usar para este pedido de texto para fala. Yes
response_format objecto Os formatos de saída de áudio suportados para texto para fala. No
speed number A velocidade da fala para áudio gerado. Os valores são válidos no intervalo de 0,25 a 4,0, sendo 1,0 o padrão e valores superiores correspondentes a fala mais rápida. No 1
stream_format enumeração O formato para transmitir o áudio. Os formatos suportados são sse e audio. sse não é suportado para tts-1 ou tts-1-hd.
Valores possíveis: sse, audio		 No
voice objecto Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/octet-stream cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Sintetiza áudio a partir do texto fornecido.

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

Respostas: Código de Estado: 200

{
  "body": "101010101"
}

Create transcription

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
chunking_strategy objecto No
└─ prefix_padding_ms número inteiro Quantidade de áudio a incluir antes do VAD detetar a fala (em milissegundos). No 300
└─ silence_duration_ms número inteiro Duração do silêncio para detetar a paragem da fala (em milissegundos). Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do utilizador. No 200
└─ threshold number Limiar de sensibilidade (0.0 a 1.0) para deteção de atividade de voz. Um limiar mais elevado exigirá um áudio mais alto para ativar o modelo, podendo assim ter melhor desempenho em ambientes ruidosos. No 0.5
└─ type enumeração Deve estar definido para server_vad permitir o chunking manual usando VAD do lado do servidor.
Valores possíveis: server_vad		 No
ficheiro cadeia (de caracteres) Yes
filename cadeia (de caracteres) O nome opcional do ficheiro ou identificador descritivo para associar aos dados de áudio. No
include[] matriz Informação adicional a incluir na resposta de transcrição. logprobs devolverá as probabilidades logarítmicas dos tokens na resposta para compreender a confiança do modelo na transcrição. logprobs Funciona apenas com response_format definidos como json e apenas com os modelos gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, e gpt-4o-mini-transcribe-2025-12-15. No
linguagem cadeia (de caracteres) A linguagem do áudio de entrada. Fornecer a linguagem de entrada no formato ISO-639-1 (por exemplo, en) irá melhorar a precisão e a latência. No
modelo cadeia (de caracteres) O modelo a usar para este pedido de transcrição. No
avisar cadeia (de caracteres) Um texto opcional para guiar o estilo do modelo ou continuar um segmento áudio anterior. O prompt deve corresponder à linguagem do áudio. No
response_format objecto No
fluxo boolean Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. Nota: O streaming não é suportado para o whisper-1 modelo e será ignorado. No False
temperature number A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística. Se definido para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos. No 0
timestamp_granularities[] matriz As granularidades do carimbo temporal para preencher esta transcrição. response_format deve ser definido verbose_json para usar granularidades de carimbo temporal. Uma ou ambas estas opções são suportadas: word, ou segment. Nota: Não existe latência adicional para carimbos temporais de segmentos, mas gerar carimbos temporais de palavra implica latência adicional. No ['segment']

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureAudioTranscriptionResponse
text/plain cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Respostas: Código de Estado: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Create translation

POST {endpoint}/openai/v1/audio/translations?api-version=preview

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
ficheiro cadeia (de caracteres) Yes
filename cadeia (de caracteres) O nome opcional do ficheiro ou identificador descritivo a associar aos dados de áudio No
modelo cadeia (de caracteres) O modelo a usar para este pedido de tradução. No
avisar cadeia (de caracteres) Um texto opcional para guiar o estilo do modelo ou continuar um segmento áudio anterior. O enunciado deve estar em inglês. No
response_format objecto No
temperature number A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística. Se definido para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos. No 0

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureAudioTranslationResponse
text/plain cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/audio/translations?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

Respostas: Código de Estado: 200

{
  "body": "plain text when requesting text, srt, or vtt"
}

Criar conclusão de chat

POST {endpoint}/openai/v1/chat/completions?api-version=preview

Cria uma conclusão do chat.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
audio objecto Parâmetros para saída de áudio. É obrigatório quando a saída de áudio é solicitada com modalities: ["audio"]. No
└─ format 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		 No
└─ voice objecto No
data_sources matriz As fontes de dados a usar para a funcionalidade On Your Data, exclusiva do Azure OpenAI. No
frequency_penalty number Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na sua frequência existente no texto até agora, diminuindo a probabilidade do modelo repetir a mesma frase literalmente. No 0
function_call enumeração Especificar uma função particular via {"name": "my_function"} obriga o modelo a chamar essa função.
Valores possíveis: none, auto		 No
functions matriz Descontinuado em favor de tools.
Uma lista de funções para as quais o modelo pode gerar entradas JSON.		 No
logit_bias objecto Modificar a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto JSON que mapeia os tokens (especificados pelo seu ID de token no tokenizador) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará consoante o modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar numa proibição ou na seleção exclusiva do token relevante. No None
logprobs boolean Se deve devolver as probabilidades logarítmicas dos tokens de saída ou não. Se for verdadeiro, devolve as probabilidades logarítmicas de cada token de saída devolvido no content de message. No False
max_completion_tokens número inteiro Um limite superior para o número de tokens que podem ser gerados para uma conclusão, incluindo tokens de saída visíveis e tokens de raciocínio. No
max_tokens número inteiro O número máximo de tokens que podem ser gerados na conclusão do chat.
Este valor pode ser usado para controlar custos de texto gerado via API.
Este valor está agora obsoleto em favor de max_completion_tokens, e não é compatível com modelos da série o1.		 No
messages matriz Uma lista de mensagens que compõem a conversa até agora. Dependendo do modelo que utiliza, são suportados diferentes tipos de mensagens (modalidades), 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ção adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.
As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
modalities objecto Tipos de saída que gostaria que o modelo gerasse.
A maioria dos modelos é capaz de gerar texto, que é o padrão:

["text"]

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

["text", "audio"]		 No
modelo cadeia (de caracteres) O identificador de implementação do modelo a usar para o pedido de conclusão do chat. Yes
n número inteiro Quantas opções de conclusão de chat gerar para cada mensagem de entrada. Note que será cobrado com base no número de tokens gerados em todas as opções. Mantenha-se n para 1 minimizar custos. No 1
parallel_tool_calls objecto Se deve ativar a chamada paralela de funções durante a utilização da ferramenta. No
predição objecto Representação base da saída prevista a partir de um modelo. No
└─ type OpenAI.ChatOutputPredictionType No
presence_penalty number Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em que aparecem ou não no texto até agora, aumentando a probabilidade do modelo de falar sobre novos temas. No 0
reasoning_effort objecto Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
response_format objecto No
└─ type enumeração
Valores possíveis: text, json_object, json_schema		 No
seed número inteiro Esta funcionalidade está em Beta.
Se especificado, o nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que pedidos repetidos com os mesmos seed parâmetros e devolvam o mesmo resultado.
O determinismo não é garantido, e deve consultar o system_fingerprint parâmetro de resposta para monitorizar as alterações no backend.		 No
stop objecto Não suportado com os modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências em que a API deixa de gerar mais tokens. O texto devolvido não conterá a sequência de paragens.		 No
armazenar boolean Se deve ou não armazenar a saída deste pedido de conclusão de chat para utilização em produtos de destilação ou avaliação de modelos. No False
fluxo boolean Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. No False
stream_options objecto Opções para resposta ao streaming. Só define isto quando defines stream: true. No
└─ include_usage boolean Se ativado, um segmento adicional será transmitido antes da data: [DONE] mensagem. O usage campo neste bloco mostra as estatísticas de utilização do token para todo o pedido, e o choices campo será sempre um array vazio.

Todos os outros chunks também incluirão um usage campo, mas com valor nulo. NOTA: Se o stream for interrompido, pode não receber o bloco final de utilização que contém o total de utilização do token para o pedido.		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual (se houver) ferramenta chamada pelo modelo.
none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.
required significa que o modelo tem de chamar uma ou mais ferramentas.
Especificar uma ferramenta específica obriga {"type": "function", "function": {"name": "my_function"}} o modelo a chamar essa ferramenta.

none é o padrão quando não há ferramentas presentes. auto é o padrão se houver ferramentas presentes.		 No
tools matriz Uma lista de ferramentas que o modelo pode chamar. Atualmente, apenas funções são suportadas como ferramenta. Use isto para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. São suportadas um máximo de 128 funções. No
top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No 1
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a monitorizar e detetar abusos. No
user_security_context AzureUserSecurityContext O contexto de segurança do utilizador contém vários parâmetros que descrevem a própria aplicação e o utilizador final que interage com a aplicação. Estes campos ajudam as suas equipas de operações de segurança a investigar e mitigar incidentes de segurança, fornecendo uma abordagem abrangente para proteger as suas aplicações de IA. Saiba mais sobre como proteger aplicações de IA usando Microsoft Defender para a Cloud. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureCreateChatCompletionResponse
text/event-stream AzureCreateChatCompletionStreamResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

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

POST {endpoint}/openai/v1/chat/completions?api-version=preview

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

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

Create embedding

POST {endpoint}/openai/v1/embeddings?api-version=preview

Cria um vetor de embedding que representa o texto de entrada.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
dimensions número inteiro O número de dimensões que os embeddings de saída resultantes devem ter. Só suportado em text-embedding-3 modelos e modelos posteriores. No
encoding_format enumeração O formato para devolver os embeddings. Pode ser qualquer um ou floatbase64outro.
Valores possíveis: float, base64		 No
dados introduzidos String ou array Yes
modelo cadeia (de caracteres) O modelo a usar para o pedido de embedding. Yes
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.CreateEmbeddingResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Devolva os embeddings para um determinado prompt.

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

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

List evals

GET {endpoint}/openai/v1/evals?api-version=preview

Liste avaliações para um projeto.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
after consulta No cadeia (de caracteres) Identificador para a última avaliação do pedido anterior de paginação.
limit consulta No número inteiro Um limite no número de avaliações a devolver numa única resposta de paginação.
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordena as avaliações por carimbo temporal. Usar asc para ordem crescente ou desc para ordem decrescente.
order_by consulta No cadeia (de caracteres)
Valores possíveis: created_at, updated_at		 As avaliações podem ser ordenadas pela hora de criação ou pela última atualização. Usa created_at para o momento de criação ou updated_at para a última atualização.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.EvalList

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Createeval

POST {endpoint}/openai/v1/evals?api-version=preview

Crie a estrutura de uma avaliação que possa 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, pode executá-la em diferentes modelos e parâmetros do modelo. Apoiamos vários tipos de avaliadores e fontes de dados.

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
data_source_config objecto Yes
└─ type OpenAI.EvalDataSourceConfigType No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da avaliação. No
statusCode enumeração
Valores possíveis: 201		 Yes
testing_criteria matriz Uma lista de avaliadores para todas as corridas de avaliação neste grupo. Os avaliadores podem referenciar variáveis na fonte de dados usando a notação de colchetes duplos, como {{item.variable_name}}. Para referenciar a saída do modelo, use o sample namespace (ou seja, {{sample.output_text}}). Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.Eval

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Get eval

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

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

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.Eval

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Update eval

POST {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Atualizar as propriedades selecionadas e mutáveis de uma avaliação especificada.

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
metadados OpenAI.MetadataPropertyForRequest Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.Eval

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Delete eval

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

Apague uma avaliação especificada.

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json objecto

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Faz as avaliações

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

Recupere uma lista de corridas para uma avaliação específica.

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)
after consulta No cadeia (de caracteres)
limit consulta No número inteiro
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc
estado consulta No cadeia (de caracteres)
Valores possíveis: queued, in_progress, completed, canceled, failed

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunList

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar corrida de avaliação

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

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

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
data_source objecto Yes
└─ type OpenAI.EvalRunDataSourceType No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da corrida. No

Responses

Código de Estado: 201

Descrição: O pedido foi bem-sucedido e foi criado um novo recurso como resultado.

Content-Type Type Description
application/json OpenAI.EvalRun

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Faz a avaliação correr

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

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

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)
run_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Cancelar corrida de avaliação

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

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

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)
run_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

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

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)
run_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json objecto

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obtém itens de saída de execução de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

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

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)
run_id caminho Yes cadeia (de caracteres)
after consulta No cadeia (de caracteres)
limit consulta No número inteiro
estado consulta No cadeia (de caracteres)
Valores possíveis: fail, pass
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItemList

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obtenha o item de saída da corrida de avaliação

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

Recuperar um item de saída específico de uma avaliação executada pelo seu ID.

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
aoai-evals cabeçalho Yes cadeia (de caracteres)
Valores possíveis: preview		 Permite o acesso às Avaliações AOAI, uma funcionalidade de pré-visualização.
Esta funcionalidade exige que o cabeçalho 'aoai-evals' esteja definido como 'pré-visualização'.
eval_id caminho Yes cadeia (de caracteres)
run_id caminho Yes cadeia (de caracteres)
output_item_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItem

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Create file

POST {endpoint}/openai/v1/files?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
expires_after objecto Yes
└─ anchor AzureFileExpiryAnchor No
└─ seconds número inteiro No
ficheiro cadeia (de caracteres) Yes
purpose enumeração O propósito pretendido do ficheiro carregado. Um dos: - assistants: Usado na API de Assistentes - batch: Usado na API de Batch - fine-tune: Usado para afinação fina - evals: Usado para conjuntos de dados de avaliação
Valores possíveis: assistants, batch, fine-tune, evals		 Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

POST {endpoint}/openai/v1/files?api-version=preview

List files

GET {endpoint}/openai/v1/files?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
purpose consulta No cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureListFilesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Retrieve file

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
file_id caminho Yes cadeia (de caracteres) O ID do ficheiro a usar para este pedido.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Delete file

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
file_id caminho Yes cadeia (de caracteres) O ID do ficheiro a usar para este pedido.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.DeleteFileResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Download file

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
file_id caminho Yes cadeia (de caracteres) O ID do ficheiro a usar para este pedido.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/octet-stream cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

Faz uma correção.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
grader objecto Um objeto StringCheckGrader que realiza uma comparação de strings entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. No
└─ evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 No
└─ graders objecto No
└─ image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
└─ input matriz O texto de entrada. Isto pode incluir cadeias de templates. No
└─ model cadeia (de caracteres) O modelo a usar para a avaliação. No
└─ name cadeia (de caracteres) O nome do avaliador. No
└─ operation enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 No
└─ range matriz A amplitude da partitura. Por defeito, é [0, 1]. No
└─ reference cadeia (de caracteres) O texto a ser avaliado. No
└─ sampling_params Os parâmetros de amostragem para o modelo. No
└─ source cadeia (de caracteres) O código-fonte do script Python. No
└─ type enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 No
item O item do conjunto de dados fornecido ao avaliador. Isto será usado para preencher o item namespace. No
model_sample cadeia (de caracteres) A amostra do modelo a ser avaliada. Este valor será usado para preencher o sample namespace.
A output_json variável será preenchida se a amostra do modelo for uma string JSON válida.		 Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.RunGraderResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Validate grader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

Valida um avaliador.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
grader objecto Um objeto StringCheckGrader que realiza uma comparação de strings entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. No
└─ evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 No
└─ graders objecto No
└─ image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
└─ input matriz O texto de entrada. Isto pode incluir cadeias de templates. No
└─ model cadeia (de caracteres) O modelo a usar para a avaliação. No
└─ name cadeia (de caracteres) O nome do avaliador. No
└─ operation enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 No
└─ range matriz A amplitude da partitura. Por defeito, é [0, 1]. No
└─ reference cadeia (de caracteres) O texto a ser avaliado. No
└─ sampling_params Os parâmetros de amostragem para o modelo. No
└─ source cadeia (de caracteres) O código-fonte do script Python. No
└─ type enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ValidateGraderResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar um trabalho de afinação fina

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Cria uma tarefa de ajuste fino que inicia o processo de criação de um novo modelo a partir de um dado conjunto de dados.

A resposta inclui detalhes do trabalho em fila, incluindo o estado da tarefa e o nome dos modelos finamente ajustados uma vez concluído.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
hyperparameters objecto Os hiperparâmetros usados para o trabalho de ajuste fino.
Este valor está agora obsoleto em favor de method, e deve ser passado sob o method parâmetro.		 No
└─ batch_size enumeração
Valores possíveis: auto		 No
└─ learning_rate_multiplier enumeração
Valores possíveis: auto		 No
└─ n_epochs enumeração
Valores possíveis: auto		 No
integrations matriz Uma lista de integrações para ativar para o seu trabalho de afinação. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
método OpenAI.FineTuneMethod O método usado para afinações. No
modelo string (ver modelos válidos abaixo) O nome do modelo a afinar. Yes
seed número inteiro A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros seed e job deve produzir os mesmos resultados, mas pode diferir em casos raros.
Se uma semente não for especificada, será gerada uma para si.		 No
suffix cadeia (de caracteres) Uma sequência de até 64 caracteres que será adicionada ao seu nome de modelo afinado.

Por exemplo, um suffix de "nome-modelo-personalizado" produziria um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No None
training_file cadeia (de caracteres) O ID de um ficheiro carregado que contém dados de treino. O seu conjunto de dados deve estar formatado como um ficheiro JSONL. Além disso, deve carregar o seu ficheiro com o propósito fine-tunede .

O conteúdo do ficheiro deve variar dependendo se o modelo usa o formato de chat, completions ou se o método de ajuste fino utiliza o formato de preferência.		 Yes
validation_file cadeia (de caracteres) O ID de um ficheiro carregado que contém dados de validação.

Se fornecer este ficheiro, os dados são usados para gerar métricas de validação periodicamente durante o ajuste fino. Estas métricas podem ser visualizadas no ficheiro de resultados de ajuste fino.
Os mesmos dados não devem estar presentes tanto nos ficheiros de treino como nos de validação.

O seu conjunto de dados deve estar formatado como um ficheiro JSONL. Deve carregar o seu ficheiro com o propósito fine-tunede .		 No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listas de trabalhos de afinação paginada

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=preview

Liste os trabalhos de afinamento da sua organização

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
after consulta No cadeia (de caracteres) Identificador do último trabalho do pedido anterior de paginação.
limit consulta No número inteiro Número de trabalhos de afinação para recuperar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListPaginatedFineTuningJobsResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Recuperar o trabalho de afinação

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

Obtenha informações sobre um trabalho de afinação.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
fine_tuning_job_id caminho Yes cadeia (de caracteres) O ID do trabalho de afinação.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Cancelar o trabalho de afinação

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

Cancela imediatamente um ajuste fino.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
fine_tuning_job_id caminho Yes cadeia (de caracteres) O ID do trabalho de ajuste fino para cancelar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Lista de pontos de controlo de tarefas de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

Lista os pontos de controlo para um trabalho de afinação.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
fine_tuning_job_id caminho Yes cadeia (de caracteres) O ID do trabalho de ajuste fino para obter pontos de controlo.
after consulta No cadeia (de caracteres) Identificador para o último ID do ponto de controlo do pedido de paginação anterior.
limit consulta No número inteiro Número de pontos de controlo para recuperar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobCheckpointsResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Lista de eventos de ajuste fino

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

Obtenha atualizações de estado para um trabalho de afinamento.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
fine_tuning_job_id caminho Yes cadeia (de caracteres) O ID do trabalho de ajuste fino para obter eventos para.
after consulta No cadeia (de caracteres) Identificador do último evento do pedido de paginação anterior.
limit consulta No número inteiro Número de eventos para recuperar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobEventsResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Pausar o ajuste fino

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

Pausa um trabalho de afinação.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
fine_tuning_job_id caminho Yes cadeia (de caracteres) O ID do trabalho de ajuste fino para pausar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Trabalho de afinamento do currículo

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

Retome um trabalho de afinamento pausado.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
fine_tuning_job_id caminho Yes cadeia (de caracteres) O ID do trabalho de afinação para retomar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar edição de imagem

POST {endpoint}/openai/v1/images/edits?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
em segundo plano enumeração Permite definir transparência para o fundo da(s) imagem(s) gerada(s).
Este parâmetro é suportado apenas para gpt-image-1 modelos. Deve ser um de transparent, opaque ou auto (valor padrão). Quando auto é utilizado, o modelo determina automaticamente o melhor fundo para a imagem.

Se transparent, o formato de saída precisa de suportar transparência, por isso deve ser definido para png (valor padrão) ou webp.
Valores possíveis: transparent, opaque, auto		 No
imagem String ou array Yes
máscara cadeia (de caracteres) No
modelo cadeia (de caracteres) A implementação do modelo a usar para a operação de edição de imagem. Yes
n número inteiro O número de imagens a gerar. Deve estar entre 1 e 10. No 1
output_compression número inteiro O nível de compressão (0-100%) para as imagens geradas. Este parâmetro é suportado apenas para gpt-image-1modelos da série -com os webp formatos de saída ou jpeg , e por defeito é 100. No 100
output_format enumeração O formato em que as imagens geradas são devolvidas. Este parâmetro é suportado apenas para gpt-image-1modelos em série -. Deve ser um dos png, jpeg, ou webp.
O valor padrão é png.
Valores possíveis: png, jpeg, webp		 No
avisar cadeia (de caracteres) Uma descrição em texto da(s) imagem(ões) desejada(s). O comprimento máximo é de 1000 caracteres para dall-e-2, e 32000 caracteres para gpt-image-1modelos da série -. Yes
quality enumeração A qualidade da imagem que será gerada. high, medium e low são apenas suportados para gpt-image-1modelos da série -. dall-e-2 Só suporta standard qualidade. Por defeito, é auto.
Valores possíveis: standard, low, medium, high, auto		 No
response_format enumeração O formato em que as imagens geradas são devolvidas. Deve ser um dos url ou b64_json. Os URLs só são válidos durante 60 minutos após a imagem ter sido gerada. Este parâmetro é suportado apenas para dall-e-2, pois gpt-image-1modelos em série retornam sempre imagens codificadas base64.
Valores possíveis: url, b64_json		 No
size enumeração O tamanho das imagens geradas. Deve ser um de 1024x1024, 1536x1024 (paisagem), 1024x1536 (retrato) ou auto (valor padrão) para gpt-image-1modelos da série -, e um de 256x256, 512x512, ou 1024x1024 para dall-e-2.
Valores possíveis: 256x256, 512x512, 1024x1024, 1536x1024, 1024x1536, auto		 No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureImagesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Createimage

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
em segundo plano enumeração Permite definir transparência para o fundo da(s) imagem(s) gerada(s).
Este parâmetro é suportado apenas para gpt-image-1 modelos. Deve ser um de transparent, opaque ou auto (valor padrão). Quando auto é utilizado, o modelo determina automaticamente o melhor fundo para a imagem.

Se transparent, o formato de saída precisa de suportar transparência, por isso deve ser definido para png (valor padrão) ou webp.
Valores possíveis: transparent, opaque, auto		 No
modelo cadeia (de caracteres) A implementação do modelo para usar na geração de imagens. Yes
moderation enumeração Controlar o nível de moderação de conteúdo para imagens geradas por gpt-image-1modelos da série -. Deve ser ou low para filtragem menos restritiva ou auto (valor padrão).
Valores possíveis: low, auto		 No
n número inteiro O número de imagens a gerar. Deve estar entre 1 e 10. Para dall-e-3, apenas n=1 é suportado. No 1
output_compression número inteiro O nível de compressão (0-100%) para as imagens geradas. Este parâmetro é suportado apenas para gpt-image-1modelos da série -com os webp formatos de saída ou jpeg , e por defeito é 100. No 100
output_format enumeração O formato em que as imagens geradas são devolvidas. Este parâmetro é suportado apenas para gpt-image-1modelos em série -. Deve ser um dos png, jpeg, ou webp.
Valores possíveis: png, jpeg, webp		 No
avisar cadeia (de caracteres) Uma descrição em texto da(s) imagem(ões) desejada(s). O comprimento máximo é de 32000 caracteres para gpt-image-1modelos da série -, 1000 caracteres para dall-e-2 e 4000 caracteres para dall-e-3. Yes
quality enumeração A qualidade da imagem que será gerada.

- auto (valor padrão) seleciona automaticamente a melhor qualidade para o modelo dado.
- high, medium e low são suportados para gpt-image-1modelos da série -.
- hd e standard são suportados para dall-e-3.
- standard é a única opção para dall-e-2.
Valores possíveis: standard, hd, low, medium, high, auto		 No
response_format enumeração O formato em que as imagens geradas com dall-e-2 e dall-e-3 são devolvidas. Deve ser um dos url ou b64_json. Os URLs só são válidos durante 60 minutos após a imagem ter sido gerada. Este parâmetro não é suportado para gpt-image-1modelos da série -que retornam sempre imagens codificadas base64.
Valores possíveis: url, b64_json		 No
size enumeração O tamanho das imagens geradas. Deve ser um de 1024x1024, 1536x1024 (paisagem), 1024x1536 (retrato) ou auto (valor padrão) para gpt-image-1modelos da série -, um de 256x256, 512x512, ou 1024x1024 para dall-e-2, e um de 1024x1024, 1792x1024, ou 1024x1792 para dall-e-3.
Valores possíveis: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x5121792x10241024x1792		 No
style enumeração O estilo das imagens geradas. Este parâmetro é suportado apenas para dall-e-3. Deve ser um dos vivid ou natural. O vívido faz com que o modelo se incline para gerar imagens hiper-reais e dramáticas. Natural faz com que o modelo produza imagens mais naturais, menos hiper-realistas.
Valores possíveis: vivid, natural		 No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureImagesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Cria imagens com um prompt.

POST {endpoint}/openai/v1/images/generations?api-version=preview

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

Respostas: Código de Estado: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

List models

GET {endpoint}/openai/v1/models?api-version=preview

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListModelsResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Retrieve model

GET {endpoint}/openai/v1/models/{model}?api-version=preview

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

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
modelo caminho Yes cadeia (de caracteres) O ID do modelo a usar para este pedido.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.Model

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Create response

POST {endpoint}/openai/v1/responses?api-version=preview

Cria uma resposta modelo.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
em segundo plano boolean Se deve executar a resposta do modelo em segundo plano. No False
include matriz Especifique dados de saída adicionais para incluir 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 nos itens de chamada à ferramenta do interpretador de código.
- computer_call_output.output.image_url: Incluir URLs de imagem da saída da chamada do computador.
- file_search_call.results: Inclua os resultados de pesquisa da chamada da ferramenta de pesquisa de ficheiros.
- message.input_image.image_url: Incluir URLs de imagem da mensagem de entrada.
- message.output_text.logprobs: Incluir logprobs com mensagens de assistente.
- reasoning.encrypted_content: Inclui uma versão encriptada dos tokens de raciocínio nas saídas dos itens de raciocínio. Isto permite que itens de raciocínio sejam usados em conversas com múltiplas curvas ao utilizar a API Respostas sem estado (como quando o store parâmetro está definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).		 No
dados introduzidos String ou array No
instructions cadeia (de caracteres) Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
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 No
max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
modelo cadeia (de caracteres) A implementação do modelo a usar para a criação desta resposta. Yes
parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
avisar objecto Referência a um modelo de prompt e às suas variáveis. No
└─ id cadeia (de caracteres) O identificador único do modelo de prompt a usar. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis no teu prompt. Os valores de substituição podem ser cadeias ou outros tipos de entrada de resposta, como imagens ou ficheiros. No
└─ version cadeia (de caracteres) Versão opcional do modelo de prompt. No
reasoning objecto Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ effort OpenAI.ReasoningEffort Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
└─ generate_summary enumeração Obsoleto: usa 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
└─ summary 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
armazenar boolean Se deve armazenar a resposta gerada do modelo para recuperação posterior via API. No True
fluxo boolean Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. No False
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No 1
enviar SMS objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objecto Controla qual (se houver) ferramenta chamada pelo modelo.

none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo tem de chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta incorporada para gerar uma resposta. No
tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. You
pode especificar que ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem as capacidades do modelo, como a pesquisa de ficheiros.
- Chamadas de função (ferramentas personalizadas): Funções definidas por si, permitindo ao modelo chamar o seu próprio código.		 No
top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No 1
truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureResponse
text/event-stream OpenAI.ResponseStreamEvent

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Criar uma resposta modelo

POST {endpoint}/openai/v1/responses?api-version=preview

Get response

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Recupera uma resposta do modelo com o ID indicado.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
response_id caminho Yes cadeia (de caracteres)
include[] consulta No matriz

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json AzureResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Delete response

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

Apaga uma resposta por ID.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
response_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json objecto

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Itens de entrada da lista

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

Devolve uma lista de itens de entrada para uma dada resposta.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
response_id caminho Yes cadeia (de caracteres)
limit consulta No número inteiro Um limite para o número de objetos a devolver. O limite pode variar entre 1 e 100, e o padrão é 20.
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordena pelo created_at carimbo temporal dos objetos. asc para ordem ascendente edesc para ordem descendente.
after consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir depois=obj_foo para obter a página seguinte da lista.
before consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir antes=obj_foo para obter a página anterior da lista.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ResponseItemList

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Armazenamentos vetoriais de lista

GET {endpoint}/openai/v1/vector_stores?api-version=preview

Devolve uma lista de armazenamentos vetoriais.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
limit consulta No número inteiro Um limite para o número de objetos a devolver. O limite pode variar entre 1 e 100, e o padrão é 20.
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordena pelo created_at carimbo temporal dos objetos. asc para ordem ascendente edesc para ordem descendente.
after consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir depois=obj_foo para obter a página seguinte da lista.
before consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir antes=obj_foo para obter a página anterior da lista.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoresResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar armazenamento vetorial

POST {endpoint}/openai/v1/vector_stores?api-version=preview

Cria um armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
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. No
└─ static OpenAI.StaticChunkingStrategy No
└─ type enumeração Sempre static.
Valores possíveis: static		 No
expires_after OpenAI.VectorStoreExpirationAfter A política de expiração para uma loja vetorial. No
file_ids matriz Uma lista de IDs de ficheiros que o armazenamento vetorial deve usar. Útil para ferramentas que file_search permitem aceder a ficheiros. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da loja vetorial. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

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

Obter armazenamento vetorial

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Recupera um armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial a recuperar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Modificar o armazenamento vetorial

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Modifica um armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial a modificar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
expires_after objecto A política de expiração para uma loja vetorial. No
└─ anchor enumeração Carimbo temporal da âncora, após o qual se aplica a apólice de validade. Âncoras suportadas: last_active_at.
Valores possíveis: last_active_at		 No
└─ days número inteiro O número de dias após o tempo de ancoragem em que o armazenamento vetorial expirará. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da loja vetorial. No

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Eliminar armazenamento vetorial

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

Apaga um armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial para apagar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar lote de arquivos de armazenamento vetorial

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

Cria um lote de ficheiro de armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial para a qual criar um lote de ficheiros.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) ficheiro(s). Se não estiver definido, vou usar a auto estratégia. No
file_ids matriz Uma lista de IDs de ficheiros que o armazenamento vetorial deve usar. Útil para ferramentas que file_search permitem aceder a ficheiros. Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obter lote de ficheiro de armazenamento vetorial

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

Recupera um lote de ficheiro de armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID do armazenamento vetorial a que pertence o lote de ficheiros.
batch_id caminho Yes cadeia (de caracteres) O ID do lote de ficheiros que está a ser recuperado.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Cancelar lote de ficheiro de armazenamento vetorial

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

Cancela um lote de ficheiros de armazenamento vetorial. Isto tenta cancelar o processamento dos ficheiros neste lote o mais rapidamente possível.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID do armazenamento vetorial a que pertence o lote de ficheiros.
batch_id caminho Yes cadeia (de caracteres) O ID do lote de ficheiros para cancelar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Ficheiros de lista em lote de armazenamento vetorial

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

Devolve uma lista de ficheiros de armazenamento vetorial em lote.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID do armazenamento vetorial a que pertence o lote de ficheiros.
batch_id caminho Yes cadeia (de caracteres) O ID do lote de ficheiros a que pertencem os ficheiros.
limit consulta No número inteiro Um limite para o número de objetos a devolver. O limite pode variar entre 1 e 100, e o padrão é 20.
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordena pelo created_at carimbo temporal dos objetos. asc para ordem ascendente edesc para ordem descendente.
after consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir depois=obj_foo para obter a página seguinte da lista.
before consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir antes=obj_foo para obter a página anterior da lista.
filtro consulta No Filtrar por estado do ficheiro. Uma de in_progress, completed, failed, cancelled.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Ficheiros de armazenamento vetorial de listas

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Devolve uma lista de ficheiros de armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial a que pertencem os ficheiros.
limit consulta No número inteiro Um limite para o número de objetos a devolver. O limite pode variar entre 1 e 100, e o padrão é 20.
order consulta No cadeia (de caracteres)
Valores possíveis: asc, desc		 Ordena pelo created_at carimbo temporal dos objetos. asc para ordem ascendente edesc para ordem descendente.
after consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir depois=obj_foo para obter a página seguinte da lista.
before consulta No 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 fizer um pedido de lista e receber 100 objetos, terminando em obj_foo, a sua chamada seguinte pode incluir antes=obj_foo para obter a página anterior da lista.
filtro consulta No Filtrar por estado do ficheiro. Uma de in_progress, completed, failed, cancelled.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar ficheiro de armazenamento vetorial

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

Crie um ficheiro de armazenamento vetorial anexando um ficheiro a um armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial para a qual criar um ficheiro.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) ficheiro(s). Se não estiver definido, vou usar a auto estratégia. No
file_id cadeia (de caracteres) Um ID de ficheiro que a loja vetorial deve usar. Útil para ferramentas que file_search permitem aceder a ficheiros. Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obter ficheiro de armazenamento vetorial

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Recupera um ficheiro de armazenamento vetorial.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial a que o ficheiro pertence.
file_id caminho Yes cadeia (de caracteres) O ID do ficheiro que está a ser recuperado.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Atualizar atributos do ficheiro de armazenamento vetorial

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres)
file_id caminho Yes cadeia (de caracteres)

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Eliminar ficheiro de armazenamento vetorial

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

Apagar um ficheiro de armazenamento vetorial. Isto remove o ficheiro da loja vetorial, mas o ficheiro em si não será eliminado. Para eliminar o ficheiro, use o endpoint delete file.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
vector_store_id caminho Yes cadeia (de caracteres) O ID da loja vetorial a que o ficheiro pertence.
file_id caminho Yes cadeia (de caracteres) O ID do ficheiro para apagar.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreFileResponse

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Empregos na geração de vídeo - Criar

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Cria um novo trabalho de geração de vídeo.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Request Body

Content-Type: application/json

Name Tipo Description Required Default
height número inteiro O auge do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes
modelo cadeia (de caracteres) O nome da implementação a usar para este pedido. Yes
n_seconds número inteiro A duração do trabalho de geração de vídeo. Deve ser entre 1 e 20 segundos. No 5
n_variants número inteiro O número de vídeos a criar como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
avisar cadeia (de caracteres) O tema para este trabalho de geração de vídeo. Yes
width número inteiro A largura do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
files matriz Yes
height número inteiro O auge do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes
inpaint_items matriz Itens opcionais de pintura para este trabalho de geração de vídeo. No
modelo cadeia (de caracteres) O nome da implementação a usar para este pedido. Yes
n_seconds número inteiro A duração do trabalho de geração de vídeo. Deve ser entre 1 e 20 segundos. No 5
n_variants número inteiro O número de vídeos a criar como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
avisar cadeia (de caracteres) O tema para este trabalho de geração de vídeo. Yes
width número inteiro A largura do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json VideoGenerationJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Ficheiro de exemplo não encontrado: ./examples/create_video_generation_job_simple.json

Empregos para geração de vídeo - Lista

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

Lista empregos de geração de vídeo.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
before consulta No cadeia (de caracteres)
after consulta No cadeia (de caracteres)
limit consulta Yes número inteiro
statuses consulta No matriz

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json VideoGenerationJobList

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Ficheiro de exemplo não encontrado: ./examples/get_video_generation_job_list.json

Empregos para geração de vídeo - Obter

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Recupera propriedades de um trabalho de geração de vídeo.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
job-id caminho Yes cadeia (de caracteres) O ID do trabalho de geração de vídeo a usar para o pedido Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json VideoGenerationJob

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Ficheiro de exemplo não encontrado: ./examples/get_video_generation_job.json

Empregos na geração de vídeo - Eliminar

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

Elimina um trabalho de geração de vídeo.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
job-id caminho Yes cadeia (de caracteres) O ID do trabalho de geração de vídeo a usar para o pedido Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 204

Descrição: Não há conteúdo para enviar para este pedido, mas os cabeçalhos podem ser úteis.

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo - Obter

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

Recupera uma geração de vídeo por ID.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia (de caracteres) O ID da geração de vídeo a usar para o pedido Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
application/json VideoGeneration

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Ficheiro de exemplo não encontrado: ./examples/get_video_generation.json

Gerações de vídeo - Recuperar miniatura

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

Recupera uma miniatura do conteúdo de vídeo gerado.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia (de caracteres) O ID da geração de vídeo a usar para o pedido Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
image/jpg cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo - Recuperar conteúdo de vídeo

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Recupera o conteúdo de vídeo gerado.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia (de caracteres) O ID da geração de vídeo a usar para o pedido Azure OpenAI.
quality consulta No

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Content-Type Type Description
video/mp4 cadeia (de caracteres)

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo - Apenas para recuperar cabeçalhos de conteúdo de vídeo

HEAD {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

Recupera os cabeçalhos do conteúdo de vídeo gerado.

URI Parameters

Name In Required Tipo Description
ponto final caminho Yes cadeia (de caracteres)
url		 Suportado Azure endpoints OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com). Substitua "aoairesource" pelo nome do seu recurso Azure OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API Foundry Models para este pedido.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia (de caracteres) O ID da geração de vídeo a usar para o pedido Azure OpenAI.
quality consulta No

Request Header

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

Name Required Tipo Description
Authorization True cadeia (de caracteres) Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

Para gerar um token de autenticação usando CLI do Azure: az account get-access-token --resource https://cognitiveservices.azure.com

Type: oauth2
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Âmbito: https://ai.azure.com/.default
api-key True cadeia (de caracteres) Forneça aqui a chave API do Azure OpenAI

Responses

Código de Estado: 200

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

Código de Estado: padrão

Descrição: Uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

Define os possíveis descritores para respostas de operações áudio disponíveis.

Property Value
Description Define os possíveis descritores para respostas de operações áudio disponíveis.
Type cadeia (de caracteres)
Values transcribe
translate

AudioTranslationSegment

Informação estendida sobre um único segmento de dados de áudio traduzidos. Os segmentos geralmente representam cerca de 5-10 segundos de fala. Os limites de segmentos normalmente ocorrem entre palavras, mas não necessariamente entre frases.

Name Tipo Description Required Default
avg_logprob number A probabilidade média logarítmica associada a este segmento áudio. Yes
compression_ratio number A razão de compressão deste segmento de áudio. Yes
end number A hora em que este segmento terminou em relação ao início do áudio traduzido. Yes
id número inteiro O índice baseado em 0 deste segmento dentro de uma tradução. Yes
no_speech_prob number A probabilidade de não haver deteção de fala dentro deste segmento áudio. Yes
seek número inteiro A posição de procura associada ao processamento deste segmento áudio.
As posições de procura são expressas em centésimos de segundo.
O modelo pode processar vários segmentos a partir de uma única posição de procura, por isso, embora a posição de procura nunca represente um tempo posterior ao início do segmento, o início do segmento pode representar um tempo significativamente mais tardio do que a posição associada ao segmento.		 Yes
start number A hora em que este segmento começou em relação ao início do áudio traduzido. Yes
temperature number A pontuação de temperatura associada a este segmento áudio. Yes
enviar SMS cadeia (de caracteres) O texto traduzido que fazia parte deste segmento áudio. Yes
tokens matriz Os IDs dos tokens correspondem ao texto traduzido neste segmento áudio. Yes

AzureAIFoundryModelsApiVersion

Property Value
Type cadeia (de caracteres)
Values v1
preview

AzureAudioTranscriptionResponse

Informação do resultado para uma operação que transcreveu áudio falado em texto escrito.

Name Tipo Description Required Default
duration number A duração total do áudio é processada para produzir a informação de transcrição correspondente. No
linguagem cadeia (de caracteres) A língua falada que foi detetada nos dados de áudio transcritos.
Isto é expresso como um código de língua ISO-639-1 de duas letras, como 'en' ou 'fr'.		 No
segments matriz Uma coleção de informações sobre o tempo, probabilidades e outros detalhes de cada segmento de áudio processado. No
tarefa objecto Define os possíveis descritores para respostas de operações áudio disponíveis. No
enviar SMS cadeia (de caracteres) O texto transcrito para os dados áudio fornecidos. Yes
words matriz Uma coleção de informações sobre o momento de cada palavra processada. No

AzureAudioTranslationResponse

Informação do resultado para uma operação que traduziu áudio falado em texto escrito.

Name Tipo Description Required Default
duration number A duração total do áudio processada para produzir informação de tradução acompanhante. No
linguagem cadeia (de caracteres) A língua falada que foi detetada nos dados de áudio traduzidos.
Isto é expresso como um código de língua ISO-639-1 de duas letras, como 'en' ou 'fr'.		 No
segments matriz Uma coleção de informações sobre o tempo, probabilidades e outros detalhes de cada segmento de áudio processado. No
tarefa objecto Define os possíveis descritores para respostas de operações áudio disponíveis. No
enviar SMS cadeia (de caracteres) O texto traduzido para os dados áudio fornecidos. Yes

AzureChatCompletionResponseMessage

O componente do modelo de resposta estendida para mensagens de resposta de conclusão de chat no serviço Azure OpenAI. Este modelo adiciona suporte para contexto de mensagens de chat, utilizado pela funcionalidade On Your Data para intenção, citações e outras informações relacionadas com a geração aumentada de recuperação realizada.

Name Tipo Description Required Default
annotations matriz Anotações para a mensagem, quando aplicável, como ao usar a ferramenta de pesquisa web. No
audio objecto Se a modalidade de saída de áudio for solicitada, este objeto contém dados sobre a resposta áudio do modelo. No
└─ data cadeia (de caracteres) Bytes de áudio codificados em Base64 gerados pelo modelo, no formato especificado no pedido. No
└─ expires_at número inteiro O carimbo temporal do Unix (em segundos) para quando esta resposta áudio deixará de estar acessível no servidor para uso em conversas com múltiplos turnos. No
└─ id cadeia (de caracteres) Identificador único para esta resposta áudio. No
└─ transcript cadeia (de caracteres) Transcrição do áudio gerado pelo modelo. No
conteúdo cadeia (de caracteres) O conteúdo da mensagem. Yes
contexto objecto Uma propriedade adicional, adicionada às mensagens de resposta de conclusão do chat, produzida pelo serviço Azure OpenAI ao usar comportamento de extensão. Isto inclui informações de intenção e citação da funcionalidade Sobre os Seus Dados. No
└─ all_retrieved_documents objecto Informação resumida sobre documentos recuperados pela operação de recuperação de dados. No
└─ chunk_id cadeia (de caracteres) O ID do bloco para a multa. No
└─ content cadeia (de caracteres) O conteúdo da citação. No
└─ data_source_index número inteiro O índice da fonte de dados utilizada para a recuperação. No
└─ filepath cadeia (de caracteres) O caminho do ficheiro para a citação. No
└─ filter_reason enumeração Se aplicável, uma indicação do motivo pelo qual o documento foi filtrado.
Valores possíveis: score, rerank		 No
└─ original_search_score number A pontuação original da pesquisa para a recuperação. No
└─ rerank_score number A pontuação de reclassificação para a recuperação. No
└─ search_queries matriz As consultas de pesquisa executadas para recuperar documentos. No
└─ title cadeia (de caracteres) O título da citação. No
└─ url cadeia (de caracteres) O URL da citação. No
└─ citations matriz As citações produzidas pela recuperação de dados. No
└─ intent cadeia (de caracteres) A intenção detetada do histórico de conversa, que é usada para transportar o contexto da conversa entre interações No
function_call objecto Descontinuado e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, tal como gerada pelo modelo. No
└─ arguments cadeia (de caracteres) No
└─ name cadeia (de caracteres) No
reasoning_content cadeia (de caracteres) Uma propriedade de extensão específica do Azure contendo conteúdo de raciocínio gerado a partir de modelos suportados. No
refusal 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ções. No

AzureChatCompletionStreamResponseDelta

O modelo de resposta estendida para uma mensagem de resposta por chat em streaming no serviço Azure OpenAI. Este modelo adiciona suporte para contexto de mensagens de chat, utilizado pela funcionalidade On Your Data para intenção, citações e outras informações relacionadas com a geração aumentada de recuperação realizada.

Name Tipo Description Required Default
audio objecto No
└─ data cadeia (de caracteres) No
└─ expires_at número inteiro No
└─ id cadeia (de caracteres) No
└─ transcript cadeia (de caracteres) No
conteúdo cadeia (de caracteres) O conteúdo da mensagem do bloco. No
contexto objecto Uma propriedade adicional, adicionada às mensagens de resposta de conclusão do chat, produzida pelo serviço Azure OpenAI ao usar comportamento de extensão. Isto inclui informações de intenção e citação da funcionalidade Sobre os Seus Dados. No
└─ all_retrieved_documents objecto Informação resumida sobre documentos recuperados pela operação de recuperação de dados. No
└─ chunk_id cadeia (de caracteres) O ID do bloco para a multa. No
└─ content cadeia (de caracteres) O conteúdo da citação. No
└─ data_source_index número inteiro O índice da fonte de dados utilizada para a recuperação. No
└─ filepath cadeia (de caracteres) O caminho do ficheiro para a citação. No
└─ filter_reason enumeração Se aplicável, uma indicação do motivo pelo qual o documento foi filtrado.
Valores possíveis: score, rerank		 No
└─ original_search_score number A pontuação original da pesquisa para a recuperação. No
└─ rerank_score number A pontuação de reclassificação para a recuperação. No
└─ search_queries matriz As consultas de pesquisa executadas para recuperar documentos. No
└─ title cadeia (de caracteres) O título da citação. No
└─ url cadeia (de caracteres) O URL da citação. No
└─ citations matriz As citações produzidas pela recuperação de dados. No
└─ intent cadeia (de caracteres) A intenção detetada do histórico de conversa, que é usada para transportar o contexto da conversa entre interações No
function_call objecto Descontinuado e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, tal como gerada pelo modelo. No
└─ arguments cadeia (de caracteres) No
└─ name cadeia (de caracteres) No
reasoning_content cadeia (de caracteres) Uma propriedade de extensão específica do Azure contendo conteúdo de raciocínio gerado a partir de modelos suportados. No
refusal cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. No
função objecto O papel do autor de uma mensagem No
tool_calls matriz No

AzureChatDataSource

Uma representação de dados de configuração para uma única fonte de dados de chat Azure OpenAI. Isto será usado por um pedido de conclusão de chat que deverá usar extensões de chat do Azure OpenAI para aumentar o comportamento de resposta. A utilização desta configuração é compatível apenas com o Azure OpenAI.

Discriminador para AzureChatDataSource

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

Type Value Schema
azure_search AzureSearchChatDataSource
azure_cosmos_db AzureCosmosDBChatDataSource
elasticsearch ElasticsearchChatDataSource
pinecone PineconeChatDataSource
mongo_db MongoDBChatDataSource
Name Tipo Description Required Default
tipo objecto Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Name Tipo Description Required Default
access_token cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: access_token		 Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Name Tipo Description Required Default
chave cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: api_key		 Yes

AzureChatDataSourceAuthenticationOptions

Discriminador para AzureChatDataSourceAuthenticationOptions

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

Type Value Schema
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
Name Tipo Description Required Default
tipo AzureChatDataSourceAuthenticationOptionsType Yes

AzureChatDataSourceAuthenticationOptionsType

Property Value
Type cadeia (de caracteres)
Values 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

Name Tipo Description Required Default
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 internas de serviço contra a implementação de um modelo de embedding do Azure OpenAI. Em contraste com a fonte de vetorização baseada em endpoints, uma fonte de vetorização baseada em nomes de implementação deve fazer parte do mesmo recurso Azure OpenAI, mas pode ser usada mesmo em redes privadas.

Name Tipo Description Required Default
deployment_name cadeia (de caracteres) A implementação do modelo de embedding para usar na vetorização. Esta implementação deve existir dentro do mesmo recurso Azure OpenAI que a implementação do modelo utilizado para a conclusão de chats. Yes
dimensions número inteiro O número de dimensões a solicitar em embeddings.
Apenas suportado em 'text-embedding-3' e modelos posteriores.		 No
tipo enumeração O identificador de tipo, sempre 'deployment_name' para este tipo de fonte de vetorização.
Valores possíveis: deployment_name		 Yes

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name Tipo Description Required Default
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 contra a implementação de um modelo de embedding do Azure OpenAI.

Name Tipo Description Required Default
autenticação objecto Yes
└─ access_token cadeia (de caracteres) No
└─ key cadeia (de caracteres) No
└─ type enumeração
Valores possíveis: access_token		 No
dimensions número inteiro O número de dimensões a solicitar em embeddings.
Apenas suportado em 'text-embedding-3' e modelos posteriores.		 No
ponto final cadeia (de caracteres) Especifica a URL do endpoint de recurso a partir da qual os embeddings devem ser recuperados.
Deve ser no formato seguinte:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
O parâmetro de consulta de versão da API não é permitido.		 Yes
tipo enumeração O identificador de tipo, sempre 'endpoint' para este tipo de fonte de vetorização.
Valores possíveis: endpoint		 Yes

AzureChatDataSourceIntegratedVectorizationSource

Representa uma fonte integrada de vetorização conforme definida dentro do recurso de pesquisa de suporte.

Name Tipo Description Required Default
tipo enumeração O identificador de tipo, sempre 'integrado' para este tipo de fonte de vetorização.
Valores possíveis: integrated		 Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name Tipo Description Required Default
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 num ID de modelo de serviço de pesquisa. Este tipo de fonte é atualmente suportado apenas pelo Elasticsearch.

Name Tipo Description Required Default
model_id cadeia (de caracteres) O ID de construção do modelo de embedding para usar na 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

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: system_assigned_managed_identity		 Yes

AzureChatDataSourceType

Property Value
Type cadeia (de caracteres)
Values azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name Tipo Description Required Default
managed_identity_resource_id cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: user_assigned_managed_identity		 Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name Tipo Description Required Default
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 recurso de embedding com uma fonte de dados.

Discriminador para AzureChatDataSourceVectorizationSource

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

Type Value Schema
deployment_name AzureChatDataSourceDeploymentNameVectorizationSource
integrated AzureChatDataSourceIntegratedVectorizationSource
model_id AzureChatDataSourceModelIdVectorizationSource
Name Tipo Description Required Default
tipo objecto Yes

AzureChatDataSourceVectorizationSourceType

Property Value
Type cadeia (de caracteres)
Values endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

Uma propriedade adicional, adicionada às mensagens de resposta de conclusão do chat, produzida pelo serviço Azure OpenAI ao usar comportamento de extensão. Isto inclui informações de intenção e citação da funcionalidade Sobre os Seus Dados.

Name Tipo Description Required Default
all_retrieved_documents objecto Informação resumida sobre documentos recuperados pela operação de recuperação de dados. No
└─ chunk_id cadeia (de caracteres) O ID do bloco para a multa. No
└─ content cadeia (de caracteres) O conteúdo da citação. No
└─ data_source_index número inteiro O índice da fonte de dados utilizada para a recuperação. No
└─ filepath cadeia (de caracteres) O caminho do ficheiro para a citação. No
└─ filter_reason enumeração Se aplicável, uma indicação do motivo pelo qual o documento foi filtrado.
Valores possíveis: score, rerank		 No
└─ original_search_score number A pontuação original da pesquisa para a recuperação. No
└─ rerank_score number A pontuação de reclassificação para a recuperação. No
└─ search_queries matriz As consultas de pesquisa executadas para recuperar documentos. No
└─ title cadeia (de caracteres) O título da citação. No
└─ url cadeia (de caracteres) O URL da citação. No
citations matriz As citações produzidas pela recuperação de dados. No
intenção cadeia (de caracteres) A intenção detetada do histórico de conversa, que é usada para transportar o contexto da conversa entre interações No

AzureContentFilterBlocklistResult

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

Name Tipo Description Required Default
details matriz Os pares de IDs individuais da lista de bloqueio e se resultaram numa ação de filtragem. No
filtered boolean Um valor que indica se alguma das listas de bloqueio detalhadas resultou numa ação de filtragem. Yes

AzureContentFilterCompletionTextSpan

Resulta uma representação de um intervalo de texto de completação, tal como usado pelo filtro de conteúdo do Azure OpenAI.

Name Tipo Description Required Default
completion_end_offset número inteiro Deslocamento do primeiro ponto de código UTF32 que está excluído do vã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 o vão. Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name Tipo Description Required Default
details matriz Informação detalhada sobre o texto de conclusão detetado. Yes
detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. Yes
filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. Yes

AzureContentFilterCustomTopicResult

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

Name Tipo Description Required Default
details matriz Os pares de IDs individuais de tópicos e se são detetados. No
filtered boolean Um valor que indica se algum dos tópicos detalhados resultou numa ação de filtragem. Yes

AzureContentFilterDetectionResult

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

Name Tipo Description Required Default
detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. Yes
filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. Yes

AzureContentFilterImagePromptResults

Um resultado de filtro de conteúdo para o pedido de conteúdo de entrada de uma operação de geração de imagem.

Name Tipo Description Required Default
custom_blocklists objecto Uma coleção de resultados de filtragem verdadeiro/falso para listas de bloqueio personalizadas configuradas. No
└─ details matriz Os pares de IDs individuais da lista de bloqueio e se resultaram numa ação de filtragem. No
└─ filtered boolean Um valor que indica se alguma das listas de bloqueio detalhadas resultou numa ação de filtragem. No
custom_topics objecto Uma coleção de resultados de filtragem verdadeiro/falso para tópicos personalizados configurados. No
└─ details matriz Os pares de IDs individuais de tópicos e se são detetados. No
└─ filtered boolean Um valor que indica se algum dos tópicos detalhados resultou numa ação de filtragem. No
jailbreak objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. Yes
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
profanity objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No

AzureContentFilterImageResponseResults

Um resultado de filtro de conteúdo para o conteúdo de resposta de saída de uma operação de geração de imagem.

Name Tipo Description Required Default
hate objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
self_harm objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
sexual objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
violence objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No

AzureContentFilterResultForChoice

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

Name Tipo Description Required Default
custom_blocklists objecto Uma coleção de resultados de filtragem verdadeiro/falso para listas de bloqueio personalizadas configuradas. No
└─ details matriz Os pares de IDs individuais da lista de bloqueio e se resultaram numa ação de filtragem. No
└─ filtered boolean Um valor que indica se alguma das listas de bloqueio detalhadas resultou numa ação de filtragem. No
custom_topics objecto Uma coleção de resultados de filtragem verdadeiro/falso para tópicos personalizados configurados. No
└─ details matriz Os pares de IDs individuais de tópicos e se são detetados. No
└─ filtered boolean Um valor que indica se algum dos tópicos detalhados resultou numa ação de filtragem. No
erro objecto Se existir, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir a sua avaliação. No
└─ code número inteiro Um código distinto, legível por máquina, associado ao erro. No
└─ message cadeia (de caracteres) Uma mensagem legível para humanos associada ao erro. No
hate objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
profanity objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
protected_material_code objecto Um resultado de deteção que descreve uma correspondência com código licenciado ou outro material fonte protegido. No
└─ citation objecto Se disponível, os detalhes da citação que descrevem a licença associada e a sua localização. No
└─ URL cadeia (de caracteres) O URL associado à licença. No
└─ license cadeia (de caracteres) O nome ou identificador da licença associada à deteção. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
protected_material_text objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
self_harm objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
sexual objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
violence objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No

AzureContentFilterResultForPrompt

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

Name Tipo Description Required Default
content_filter_results objecto O filtro de conteúdo detalha a categoria do resultado. No
└─ custom_blocklists objecto Uma coleção de resultados de filtragem verdadeiro/falso para listas de bloqueio personalizadas configuradas. No
└─ details matriz Os pares de IDs individuais da lista de bloqueio e se resultaram numa ação de filtragem. No
└─ filtered boolean Um valor que indica se alguma das listas de bloqueio detalhadas resultou numa ação de filtragem. No
└─ custom_topics objecto Uma coleção de resultados de filtragem verdadeiro/falso para tópicos personalizados configurados. No
└─ details matriz Os pares de IDs individuais de tópicos e se são detetados. No
└─ filtered boolean Um valor que indica se algum dos tópicos detalhados resultou numa ação de filtragem. No
└─ error objecto Se existir, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir a sua avaliação. No
└─ code número inteiro Um código distinto, legível por máquina, associado ao erro. No
└─ message cadeia (de caracteres) Uma mensagem legível para humanos associada ao erro. No
└─ hate objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
└─ indirect_attack objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
└─ jailbreak objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
└─ profanity objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi detetado e se foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulada foi detetada no conteúdo. No
└─ filtered boolean Se a deteção de conteúdo resultou numa ação de filtragem de conteúdo. No
└─ self_harm objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
└─ sexual objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
└─ violence objecto Um item de resultado do filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível qualitativo de gravidade do conteúdo, avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. No
└─ severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 No
prompt_index número inteiro O índice do prompt de entrada associado ao conteúdo acompanhante filtra categorias de resultados. No

AzureContentFilterSeverityResult

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

Name Tipo Description Required Default
filtered boolean Se a gravidade do conteúdo resultou numa ação de filtragem de conteúdo. Yes
severity enumeração A severidade rotulada do conteúdo.
Valores possíveis: safe, low, medium, high		 Yes

AzureCosmosDBChatDataSource

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

Name Tipo Description Required Default
parameters objecto A informação dos parâmetros para controlar o uso da fonte de dados do Azure CosmosDB. Yes
└─ allow_partial_result boolean Se definido como verdadeiro, o sistema permitirá a utilização de resultados de pesquisa parciais e o pedido falhará se todas as consultas parciais falharem. Se não for especificado ou especificado como falso, o pedido falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication AzureChatDataSourceConnectionStringAuthenticationOptions No
└─ container_name cadeia (de caracteres) No
└─ database_name cadeia (de caracteres) No
└─ embedding_dependency AzureChatDataSourceVectorizationSource Uma representação de uma fonte de vetorização de dados utilizável como recurso de embedding com uma fonte de dados. No
└─ fields_mapping objecto No
└─ content_fields matriz No
└─ content_fields_separator cadeia (de caracteres) No
└─ filepath_field cadeia (de caracteres) No
└─ title_field cadeia (de caracteres) No
└─ url_field cadeia (de caracteres) No
└─ vector_fields matriz No
└─ in_scope boolean Se as consultas devem ser restringidas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades do contexto de saída a incluir na resposta.
Por defeito, serão solicitadas citações e intenções.		 No ['citations', 'intent']
└─ index_name cadeia (de caracteres) No
└─ max_search_queries número inteiro O número máximo de consultas reescritas que devem ser enviadas ao fornecedor de pesquisa para uma única mensagem de utilizador.
Por defeito, o sistema fará uma determinação automática.		 No
└─ strictness número inteiro A rigidez configurada do filtro de relevância de pesquisa.
Maior rigor aumenta a precisão, mas reduz a recordação da resposta.		 No
└─ top_n_documents número inteiro O número configurado de documentos a destacar na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre 'azure_cosmos_db'.
Valores possíveis: azure_cosmos_db		 Yes

AzureCreateChatCompletionRequest

O modelo de pedidos estendido para completação de chats contra o serviço Azure OpenAI. Isto adiciona a possibilidade de fornecer fontes de dados para a funcionalidade On Your Data.

Name Tipo Description Required Default
audio objecto Parâmetros para saída de áudio. É obrigatório quando a saída de áudio é solicitada com modalities: ["audio"]. No
└─ format 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		 No
└─ voice objecto No
data_sources matriz As fontes de dados a usar para a funcionalidade On Your Data, exclusiva do Azure OpenAI. No
frequency_penalty number Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base na sua frequência existente no texto até agora, diminuindo a probabilidade do modelo repetir a mesma frase literalmente. No 0
function_call enumeração Especificar uma função particular via {"name": "my_function"} obriga o modelo a chamar essa função.
Valores possíveis: none, auto		 No
functions matriz Descontinuado em favor de tools.

Uma lista de funções para as quais o modelo pode gerar entradas JSON.		 No
logit_bias objecto Modificar a probabilidade de tokens especificados aparecerem na conclusão.

Aceita um objeto JSON que mapeia os tokens (especificados pelo seu ID de token no tokenizador) para um valor de viés associado de -100 a 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem.
O efeito exato variará consoante o modelo, mas valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar numa proibição ou na seleção exclusiva do token relevante.		 No None
logprobs boolean Se deve devolver as probabilidades logarítmicas dos tokens de saída ou não. Se for verdadeiro, devolve as probabilidades logarítmicas de cada token de saída devolvido no content de message. No False
max_completion_tokens número inteiro Um limite superior para o número de tokens que podem ser gerados para uma conclusão, incluindo tokens de saída visíveis e tokens de raciocínio. No
max_tokens número inteiro O número máximo de tokens que podem ser gerados na conclusão do chat.
Este valor pode ser usado para controlar custos de texto gerado via API.

Este valor está agora obsoleto em favor de max_completion_tokens, e não é compatível com modelos da série o1.		 No
messages matriz Uma lista de mensagens que compõem a conversa até agora. Dependendo do modelo que utiliza, são suportados diferentes tipos de mensagens (modalidades), 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ção adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
modalities objecto Tipos de saída que gostaria que o modelo gerasse.
A maioria dos modelos é capaz de gerar texto, que é o padrão:

["text"]

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

["text", "audio"]		 No
modelo cadeia (de caracteres) O identificador de implementação do modelo a usar para o pedido de conclusão do chat. Yes
n número inteiro Quantas opções de conclusão de chat gerar para cada mensagem de entrada. Note que será cobrado com base no número de tokens gerados em todas as opções. Mantenha-se n para 1 minimizar custos. No 1
parallel_tool_calls objecto Se deve ativar a chamada paralela de funções durante a utilização da ferramenta. No
predição objecto Representação base da saída prevista a partir de um modelo. No
└─ type OpenAI.ChatOutputPredictionType No
presence_penalty number Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em que aparecem ou não no texto até agora, aumentando a probabilidade do modelo de falar sobre novos temas. No 0
reasoning_effort objecto Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
response_format objecto No
└─ type enumeração
Valores possíveis: text, json_object, json_schema		 No
seed número inteiro Esta funcionalidade está em Beta.
Se especificado, o nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que pedidos repetidos com os mesmos seed parâmetros e devolvam o mesmo resultado.
O determinismo não é garantido, e deve consultar o system_fingerprint parâmetro de resposta para monitorizar as alterações no backend.		 No
stop objecto Não suportado com os modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências em que a API deixa de gerar mais tokens. O texto devolvido não conterá a sequência de paragens.		 No
armazenar boolean Se deve ou não armazenar a saída deste pedido de conclusão de chat para uso em destilação de modelos ou produtos de avaliação. No False
fluxo boolean Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. No False
stream_options objecto Opções para resposta ao streaming. Só define isto quando defines stream: true. No
└─ include_usage boolean Se ativado, um segmento adicional será transmitido antes da data: [DONE] mensagem. O usage campo neste bloco mostra as estatísticas de utilização do token para todo o pedido, e o choices campo será sempre um array vazio.

Todos os outros chunks também incluirão um usage campo, mas com valor nulo. NOTA: Se o stream for interrompido, pode não receber o bloco final de utilização que contém o total de utilização do token para o pedido.		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual (se houver) ferramenta chamada pelo modelo.
none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.
required significa que o modelo tem de chamar uma ou mais ferramentas.
Especificar uma ferramenta específica obriga {"type": "function", "function": {"name": "my_function"}} o modelo a chamar essa ferramenta.

none é o padrão quando não há ferramentas presentes. auto é o padrão se houver ferramentas presentes.		 No
tools matriz Uma lista de ferramentas que o modelo pode chamar. Atualmente, apenas funções são suportadas como ferramenta. Use isto para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. São suportadas um máximo de 128 funções. No
top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No 1
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a monitorizar e detetar abusos. No
user_security_context AzureUserSecurityContext O contexto de segurança do utilizador contém vários parâmetros que descrevem a própria aplicação e o utilizador final que interage com a aplicação. Estes campos ajudam as suas equipas de operações de segurança a investigar e mitigar incidentes de segurança, fornecendo uma abordagem abrangente para proteger as suas aplicações de IA. Saiba mais sobre como proteger aplicações de IA usando Microsoft Defender para a Cloud. No

AzureCreateChatCompletionResponse

O modelo estendido de resposta de conclusão de chat de topo para o serviço Azure OpenAI. Este modelo adiciona anotações do filtro de conteúdo Responsible AI para introdução de prompts.

Name Tipo Description Required Default
choices matriz Yes
created número inteiro O carimbo temporal do Unix (em segundos) de quando a conclusão do chat foi criada. Yes
id cadeia (de caracteres) Um identificador único para a conclusão da conversa. Yes
modelo cadeia (de caracteres) O modelo usado para completar o chat. Yes
objecto enumeração O tipo de objeto, que é sempre chat.completion.
Valores possíveis: chat.completion		 Yes
prompt_filter_results matriz O conteúdo da IA responsável filtra as anotações associadas a entradas de prompt para completar o chat. No
system_fingerprint cadeia (de caracteres) Esta impressão digital representa a configuração do backend com que o modelo corre.

Pode ser usado em conjunto com o seed parâmetro de pedido para perceber quando foram feitas alterações no backend que possam afetar o determinismo.		 No
utilização OpenAI.CompletionUsage Estatísticas de utilização para o pedido de conclusão. No

AzureCreateChatCompletionStreamResponse

Name Tipo Description Required Default
choices matriz Uma lista de opções para completar o chat. Pode conter mais do que um elemento se n for maior que 1. Também pode ficar vazio no último bloco se definires 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. No
created número inteiro O carimbo temporal do Unix (em segundos) de quando a conclusão do chat foi criada. Cada bloco tem o mesmo carimbo temporal. Yes
delta AzureChatCompletionStreamResponseDelta O modelo de resposta estendida para uma mensagem de resposta por chat em streaming no serviço Azure OpenAI.
Este modelo adiciona suporte para contexto de mensagens de chat, utilizado pela funcionalidade On Your Data para intenção, citações e outras informações relacionadas com a geração aumentada de recuperação realizada.		 No
id cadeia (de caracteres) Um identificador único para a conclusão da conversa. Cada bloco tem o mesmo ID. Yes
modelo cadeia (de caracteres) O modelo para gerar a completude. 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) Esta impressão digital representa a configuração do backend com que o modelo corre.
Pode ser usado em conjunto com o seed parâmetro de pedido para perceber quando foram feitas alterações no backend que possam afetar o determinismo.		 No
utilização objecto Estatísticas de utilização para o pedido de conclusão. No
└─ completion_tokens número inteiro Número de tokens na conclusão gerada. No 0
└─ completion_tokens_details objecto Divisão dos tokens usados numa conclusão. No
└─ accepted_prediction_tokens número inteiro Ao usar Saídas Previstas, o número de tokens na previsão que apareceu na completação. No 0
└─ audio_tokens número inteiro Tokens de entrada de áudio gerados pelo modelo. No 0
└─ reasoning_tokens número inteiro Tokens gerados pelo modelo para raciocínio. No 0
└─ rejected_prediction_tokens número inteiro Ao usar Saídas Previstas, o número de tokens na previsão que não apareceram na conclusão. No entanto, tal como os tokens de raciocínio, estes tokens continuam a ser contados no total de tokens de conclusão para efeitos de faturação, saída e limites de janela de contexto. No 0
└─ prompt_tokens número inteiro Número de tokens no prompt. No 0
└─ prompt_tokens_details objecto Divisão dos tokens usados no prompt. No
└─ audio_tokens número inteiro Tokens de entrada de áudio presentes no prompt. No 0
└─ cached_tokens número inteiro Tokens em cache presentes no prompt. No 0
└─ total_tokens número inteiro Número total de tokens usados no pedido (prompt + conclusão). No 0

AzureCreateEmbeddingRequest

Name Tipo Description Required Default
dimensions número inteiro O número de dimensões que os embeddings de saída resultantes devem ter. Só suportado em text-embedding-3 modelos e modelos posteriores. No
encoding_format enumeração O formato para devolver os embeddings. Pode ser qualquer um ou floatbase64outro.
Valores possíveis: float, base64		 No
dados introduzidos String ou array Yes
modelo cadeia (de caracteres) O modelo a usar para o pedido de embedding. Yes
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

AzureCreateFileRequestMultiPart

Name Tipo Description Required Default
expires_after objecto Yes
└─ anchor AzureFileExpiryAnchor No
└─ seconds número inteiro No
ficheiro cadeia (de caracteres) Yes
purpose enumeração O propósito pretendido do ficheiro carregado. Um dos: - assistants: Usado na API de Assistentes - batch: Usado na API Batch - fine-tune: Usado para ajuste fino - evals: Usado para conjuntos de dados de avaliação.
Valores possíveis: assistants, batch, fine-tune, evals		 Yes

AzureCreateImageEditRequestMultiPart

Name Tipo Description Required Default
em segundo plano enumeração Permite definir transparência para o fundo da(s) imagem(s) gerada(s).
Este parâmetro é suportado apenas para gpt-image-1 modelos. Deve ser um de transparent, opaque ou auto (valor padrão). Quando auto é utilizado, o modelo determina automaticamente o melhor fundo para a imagem.

Se transparent, o formato de saída precisa de suportar transparência, por isso deve ser definido para png (valor padrão) ou webp.
Valores possíveis: transparent, opaque, auto		 No
imagem String ou array Yes
máscara cadeia (de caracteres) No
modelo cadeia (de caracteres) A implementação do modelo a usar para a operação de edição de imagem. Yes
n número inteiro O número de imagens a gerar. Deve estar entre 1 e 10. No 1
output_compression número inteiro O nível de compressão (0-100%) para as imagens geradas. Este parâmetro é suportado apenas para gpt-image-1modelos da série -com os webp formatos de saída ou jpeg , e por defeito é 100. No 100
output_format enumeração O formato em que as imagens geradas são devolvidas. Este parâmetro é suportado apenas para gpt-image-1modelos em série -. Deve ser um dos png, jpeg, ou webp.
O valor padrão é png.
Valores possíveis: png, jpeg, webp		 No
avisar cadeia (de caracteres) Uma descrição em texto da(s) imagem(ões) desejada(s). O comprimento máximo é de 1000 caracteres para dall-e-2, e 32000 caracteres para gpt-image-1modelos da série -. Yes
quality enumeração A qualidade da imagem que será gerada. high, medium e low são apenas suportados para gpt-image-1modelos da série -. dall-e-2 Só suporta standard qualidade. Por defeito, é auto.
Valores possíveis: standard, low, medium, high, auto		 No
response_format enumeração O formato em que as imagens geradas são devolvidas. Deve ser um dos url ou b64_json. Os URLs só são válidos durante 60 minutos após a imagem ter sido gerada. Este parâmetro é suportado apenas para dall-e-2, pois gpt-image-1modelos em série retornam sempre imagens codificadas base64.
Valores possíveis: url, b64_json		 No
size enumeração O tamanho das imagens geradas. Deve ser um de 1024x1024, 1536x1024 (paisagem), 1024x1536 (retrato) ou auto (valor padrão) para gpt-image-1modelos da série -, e um de 256x256, 512x512, ou 1024x1024 para dall-e-2.
Valores possíveis: 256x256, 512x512, 1024x1024, 1536x1024, 1024x1536, auto		 No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

AzureCreateImageRequest

Name Tipo Description Required Default
em segundo plano enumeração Permite definir transparência para o fundo da(s) imagem(s) gerada(s).
Este parâmetro é suportado apenas para gpt-image-1 modelos. Deve ser um de transparent, opaque ou auto (valor padrão). Quando auto é utilizado, o modelo determina automaticamente o melhor fundo para a imagem.

Se transparent, o formato de saída precisa de suportar transparência, por isso deve ser definido para png (valor padrão) ou webp.
Valores possíveis: transparent, opaque, auto		 No
modelo cadeia (de caracteres) A implementação do modelo para usar na geração de imagens. Yes
moderation enumeração Controlar o nível de moderação de conteúdo para imagens geradas por gpt-image-1modelos da série -. Deve ser ou low para filtragem menos restritiva ou auto (valor padrão).
Valores possíveis: low, auto		 No
n número inteiro O número de imagens a gerar. Deve estar entre 1 e 10. Para dall-e-3, apenas n=1 é suportado. No 1
output_compression número inteiro O nível de compressão (0-100%) para as imagens geradas. Este parâmetro é suportado apenas para gpt-image-1modelos da série -com os webp formatos de saída ou jpeg , e por defeito é 100. No 100
output_format enumeração O formato em que as imagens geradas são devolvidas. Este parâmetro é suportado apenas para gpt-image-1modelos em série -. Deve ser um dos png, jpeg, ou webp.
Valores possíveis: png, jpeg, webp		 No
avisar cadeia (de caracteres) Uma descrição em texto da(s) imagem(ões) desejada(s). Yes
quality enumeração A qualidade da imagem que será gerada.

- auto (valor padrão) seleciona automaticamente a melhor qualidade para o modelo dado.
- high, medium e low são suportados para gpt-image-1modelos da série -.
- hd e standard são suportados para dall-e-3.
- standard é a única opção para dall-e-2.
Valores possíveis: standard, hd, low, medium, high, auto		 No
response_format enumeração O formato em que as imagens geradas com dall-e-2 e dall-e-3 são devolvidas. Deve ser um dos url ou b64_json. Os URLs só são válidos durante 60 minutos após a imagem ter sido gerada. Este parâmetro não é suportado para gpt-image-1modelos da série -que retornam sempre imagens codificadas base64.
Valores possíveis: url, b64_json		 No
size enumeração O tamanho das imagens geradas. Deve ser um de 1024x1024, 1536x1024 (paisagem), 1024x1536 (retrato) ou auto (valor padrão) para gpt-image-1modelos da série -, um de 256x256, 512x512, ou 1024x1024 para dall-e-2, e um de 1024x1024, 1792x1024, ou 1024x1792 para dall-e-3.
Valores possíveis: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x5121792x10241024x1792		 No
style enumeração O estilo das imagens geradas. Este parâmetro é suportado apenas para dall-e-3. Deve ser um dos vivid ou natural. O vívido faz com que o modelo se incline para gerar imagens hiper-reais e dramáticas. Natural faz com que o modelo produza imagens mais naturais, menos hiper-realistas.
Valores possíveis: vivid, natural		 No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

AzureCreateResponse

Name Tipo Description Required Default
em segundo plano boolean Se deve executar a resposta do modelo em segundo plano. No False
include matriz Especifique dados de saída adicionais para incluir 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 nos itens de chamada à ferramenta do interpretador de código.
- computer_call_output.output.image_url: Incluir URLs de imagem da saída da chamada do computador.
- file_search_call.results: Inclua os resultados de pesquisa da chamada da ferramenta de pesquisa de ficheiros.
- message.input_image.image_url: Incluir URLs de imagem da mensagem de entrada.
- message.output_text.logprobs: Incluir logprobs com mensagens de assistente.
- reasoning.encrypted_content: Inclui uma versão encriptada dos tokens de raciocínio nas saídas dos itens de raciocínio. Isto permite que itens de raciocínio sejam usados em conversas com múltiplas curvas ao utilizar a API Respostas sem estado (como quando o store parâmetro está definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).		 No
dados introduzidos String ou array No
instructions cadeia (de caracteres) Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
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 No
max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
modelo cadeia (de caracteres) A implementação do modelo a usar para a criação desta resposta. Yes
parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
avisar objecto Referência a um modelo de prompt e às suas variáveis. No
└─ id cadeia (de caracteres) O identificador único do modelo de prompt a usar. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis no teu prompt. Os valores de substituição podem ser strings ou outros tipos de entrada de Resposta, como imagens ou ficheiros. No
└─ version cadeia (de caracteres) Versão opcional do modelo de prompt. No
reasoning objecto Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ effort OpenAI.ReasoningEffort Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
└─ generate_summary enumeração Obsoleto: usa 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
└─ summary 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
armazenar boolean Se deve armazenar a resposta gerada do modelo para recuperação posterior via API. No True
fluxo boolean Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. No False
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No 1
enviar SMS objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objecto Controla qual (se houver) ferramenta chamada pelo modelo.

none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo tem de chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta incorporada para gerar uma resposta. No
tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem as capacidades do modelo, como a pesquisa de ficheiros.
- Chamadas de função (ferramentas personalizadas): Funções definidas por si, permitindo ao modelo chamar o seu próprio código.		 No
top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No 1
truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No

AzureCreateSpeechRequestMultiPart

Uma representação das opções de pedido que controlam o comportamento de uma operação de texto para fala.

Name Tipo Description Required Default
dados introduzidos cadeia (de caracteres) O texto para gerar áudio. O comprimento máximo é de 4096 caracteres. Yes
instructions cadeia (de caracteres) Controla a voz do áudio gerado com instruções adicionais. Não funciona com tts-1 ou tts-1-hd. No
modelo cadeia (de caracteres) O modelo a usar para este pedido de texto para fala. Yes
response_format objecto Os formatos de saída de áudio suportados para texto para fala. No
speed number A velocidade da fala para áudio gerado. Os valores são válidos no intervalo de 0,25 a 4,0, sendo 1,0 o padrão e valores superiores correspondentes a fala mais rápida. No 1
stream_format enumeração O formato para transmitir o áudio. Os formatos suportados são sse e audio. sse não é suportado para tts-1 ou tts-1-hd.
Valores possíveis: sse, audio		 No
voice objecto Yes

AzureCreateTranscriptionRequestMultiPart

A informação de configuração para um pedido de transcrição áudio.

Name Tipo Description Required Default
chunking_strategy objecto No
└─ prefix_padding_ms número inteiro Quantidade de áudio a incluir antes do VAD detetar a fala (em milissegundos). No 300
└─ silence_duration_ms número inteiro Duração do silêncio para detetar a paragem da fala (em milissegundos).
Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do utilizador.		 No 200
└─ threshold number Limiar de sensibilidade (0.0 a 1.0) para deteção de atividade de voz. Um limiar mais elevado exigirá um áudio mais alto para ativar o modelo, podendo assim ter melhor desempenho em ambientes ruidosos. No 0.5
└─ type enumeração Deve estar definido para server_vad permitir o chunking manual usando VAD do lado do servidor.
Valores possíveis: server_vad		 No
ficheiro cadeia (de caracteres) Yes
filename cadeia (de caracteres) O nome opcional do ficheiro ou identificador descritivo para associar aos dados de áudio. No
include[] matriz Informação adicional a incluir na resposta de transcrição.
logprobs devolverá as probabilidades logarítmicas dos tokens na resposta para compreender a confiança do modelo na transcrição.
logprobs Funciona apenas com response_format definidos como json e apenas com os modelos gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, e gpt-4o-mini-transcribe-2025-12-15.		 No
linguagem cadeia (de caracteres) A linguagem do áudio de entrada. Fornecer a linguagem de entrada no formato ISO-639-1 (por exemplo, en) irá melhorar a precisão e a latência. No
modelo cadeia (de caracteres) O modelo a usar para este pedido de transcrição. No
avisar cadeia (de caracteres) Um texto opcional para guiar o estilo do modelo ou continuar um segmento áudio anterior. O prompt deve corresponder à linguagem do áudio. No
response_format objecto No
fluxo boolean Se definido como verdadeiro, os dados de resposta do modelo serão transmitidos para o cliente à medida que são gerados usando eventos enviados pelo servidor. Nota: O streaming não é suportado para o whisper-1 modelo e será ignorado. No False
temperature number A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística. Se definido para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos. No 0
timestamp_granularities[] matriz As granularidades do carimbo temporal para preencher esta transcrição. response_format deve ser definido verbose_json para usar granularidades de carimbo temporal. Uma ou ambas estas opções são suportadas: word, ou segment. Nota: Não existe latência adicional para carimbos temporais de segmentos, mas gerar carimbos temporais de palavra implica latência adicional. No ['segment']

AzureCreateTranslationRequestMultiPart

A informação de configuração para um pedido de transcrição áudio.

Name Tipo Description Required Default
ficheiro cadeia (de caracteres) Yes
filename cadeia (de caracteres) O nome opcional do ficheiro ou identificador descritivo a associar aos dados de áudio No
modelo cadeia (de caracteres) O modelo a usar para este pedido de tradução. No
avisar cadeia (de caracteres) Um texto opcional para guiar o estilo do modelo ou continuar um segmento áudio anterior. O enunciado deve estar em inglês. No
response_format objecto No
temperature number A temperatura de amostragem, entre 0 e 1. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística. Se definido para 0, o modelo usará a probabilidade logarítmica para aumentar automaticamente a temperatura até que certos limiares sejam atingidos. No 0

AzureErrorResponse

Name Tipo Description Required Default
erro objecto O erro é detalhado. No
└─ code cadeia (de caracteres) O identificador distinto, gerado por máquina, para o erro. No
└─ inner_error No
└─ message cadeia (de caracteres) Uma mensagem legível para humanos associada ao erro. No
└─ param cadeia (de caracteres) Se aplicável, o parâmetro de entrada do pedido associado ao erro No
└─ type enumeração O tipo de objeto, sempre 'erro'.
Valores possíveis: error		 No

AzureEvalAPICompletionsSamplingParams

Name Tipo Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools matriz No

AzureEvalAPIModelSamplingParams

Name Tipo Description Required Default
max_tokens número inteiro O número máximo de tokens na saída gerada. No
reasoning_effort enumeração Controla o nível de esforço de raciocínio aplicado durante a geração.
Valores possíveis: low, medium, high		 No
seed número inteiro Um valor semente para inicializar a aleatoriedade durante a amostragem. No
temperature number Uma temperatura mais alta aumenta a aleatoriedade nas saídas. No
top_p number Uma alternativa à temperatura para amostragem de núcleos; A versão 1.0 inclui todos os tokens. No

AzureEvalAPIResponseSamplingParams

Name Tipo Description Required Default
parallel_tool_calls boolean No
response_format OpenAI.ResponseTextFormatConfiguration No
tools matriz No

AzureFileExpiryAnchor

Property Value
Type cadeia (de caracteres)
Values created_at

AzureFineTuneReinforcementMethod

Name Tipo Description Required Default
grader objecto Um objeto StringCheckGrader que realiza uma comparação de strings entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. No
└─ evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 No
└─ graders objecto No
└─ input matriz O texto de entrada. Isto pode incluir cadeias de templates. No
└─ model cadeia (de caracteres) O modelo a usar para a avaliação. No
└─ name cadeia (de caracteres) O nome do avaliador. No
└─ operation enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 No
└─ range matriz A amplitude da partitura. Por defeito, é [0, 1]. No
└─ reference cadeia (de caracteres) O texto a ser avaliado. No
└─ sampling_params Os parâmetros de amostragem para o modelo. No
└─ type enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 No
hyperparameters OpenAI.FineTuneReinforcementHyperparameters Os hiperparâmetros usados para o trabalho de ajuste fino de reforço. No
response_format objecto No
└─ json_schema objecto Esquema JSON para o formato de resposta No
└─ type enumeração Tipo de formato de resposta.
Valores possíveis: json_schema		 No

AzureImage

Name Tipo Description Required Default
b64_json cadeia (de caracteres) O JSON codificado em base64 da imagem gerada. Valor padrão para gpt-image-1modelos em -série, e só está presente se response_format for definido para b64_jsondall-e-2 e dall-e-3. No
content_filter_results AzureContentFilterImageResponseResults Um resultado de filtro de conteúdo para o conteúdo de resposta de saída de uma operação de geração de imagem. Yes
prompt_filter_results AzureContentFilterImagePromptResults Um resultado de filtro de conteúdo para o pedido de conteúdo de entrada de uma operação de geração de imagem. Yes
revised_prompt cadeia (de caracteres) Apenas dall-e-3 para o prompt revisto que foi usado para gerar a imagem. No
url cadeia (de caracteres) Ao usar dall-e-2 ou dall-e-3, a URL da imagem gerada if response_format é definida como url (valor predefinido). Não suportado para gpt-image-1modelos da série -. No

AzureImagesResponse

Name Tipo Description Required Default
em segundo plano enumeração GPT-image-1 apenas: o parâmetro de fundo usado para a geração da imagem. Ou transparentopaqueou.
Valores possíveis: transparent, opaque		 No
created número inteiro O carimbo temporal do Unix (em segundos) de quando a imagem foi criada. Yes
dados matriz No
output_format enumeração O formato de saída da geração da imagem. Ou png, webp, ou jpeg.
Valores possíveis: png, webp, jpeg		 No
quality enumeração A qualidade da imagem gerada. Ou low, medium, ou high.
Valores possíveis: low, medium, high		 No
size enumeração O tamanho da imagem gerada. Ou 1024x1024, 1024x1536, ou 1536x1024.
Valores possíveis: 1024x1024, 1024x1536, 1536x1024		 No
utilização objecto Para gpt-image-1modelos da série - apenas, a informação de utilização do token para a geração da imagem. No
└─ input_tokens número inteiro O número de tokens (imagens e texto) no prompt de entrada. No
└─ input_tokens_details objecto Os tokens de entrada fornecem informações detalhadas para a geração da imagem. No
└─ image_tokens número inteiro O número de tokens de imagem no prompt de entrada. No
└─ text_tokens número inteiro O número de tokens de texto no prompt de entrada. No
└─ output_tokens número inteiro O número de tokens de imagem na imagem de saída. No
└─ total_tokens número inteiro O número total de tokens (imagens e texto) usados para a geração de imagens. No

AzureListFilesResponse

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia (de caracteres) Yes
has_more boolean Yes
last_id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: list		 Yes

AzureOpenAIFile

Name Tipo Description Required Default
bytes número inteiro O tamanho do ficheiro, em bytes. Yes
created_at número inteiro O carimbo temporal do Unix (em segundos) para quando o ficheiro foi criado. Yes
expires_at número inteiro O carimbo temporal do Unix (em segundos) indica quando o ficheiro vai expirar. No
filename cadeia (de caracteres) O nome do ficheiro. Yes
id cadeia (de caracteres) O identificador de ficheiro, que pode ser referenciado nos endpoints da API. Yes
objecto enumeração O tipo de objeto, que é sempre file.
Valores possíveis: file		 Yes
purpose enumeração O propósito pretendido do ficheiro. Os valores suportados são assistants, assistants_output, batch, batch_output, e fine-tunefine-tune-results .
Valores possíveis: assistants, assistants_output, batch, batch_output, fine-tunefine-tune-resultsevals		 Yes
estado enumeração
Valores possíveis: uploaded, pending, running, processed, errordeletingdeleted		 Yes
status_details cadeia (de caracteres) Deprecated. Para detalhes sobre o motivo pelo qual um ficheiro de treino de ajuste fino falhou na validação, consulte o error campo em fine_tuning.job. No

AzureOpenAIVideoGenerationErrorResponse

Name Tipo Description Required Default
código cadeia (de caracteres) O identificador distinto, gerado por máquina, para o erro. No
inner_error objecto Se aplicável, um erro a montante que originou este erro. No
└─ code enumeração O código associado ao erro interno.
Valores possíveis: ResponsibleAIPolicyViolation		 No
└─ error_details O filtro de conteúdo resulta em detalhes associados ao erro interno. No
└─ revised_prompt cadeia (de caracteres) Se aplicável, o prompt modificado usado para geração. No
mensagem cadeia (de caracteres) Uma mensagem legível para humanos associada ao erro. No
param cadeia (de caracteres) Se aplicável, o parâmetro de entrada do pedido associado ao erro No
tipo cadeia (de caracteres) Se aplicável, o número da linha de entrada associado ao erro. No

AzureResponse

Name Tipo Description Required Default
em segundo plano boolean Se deve executar a resposta do modelo em segundo plano. No False
created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. Yes
erro objecto Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. Yes
└─ code OpenAI.ResponseErrorCode O código de erro da resposta. No
└─ message cadeia (de caracteres) Uma descrição legível para humanos do erro. No
id cadeia (de caracteres) Identificador único para esta Resposta. Yes
incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. Yes
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
instructions String ou array 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 No
max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
modelo cadeia (de caracteres) O modelo usado para gerar esta resposta. Yes
objecto enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 Yes
output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 Yes
output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. Yes True
previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
avisar objecto Referência a um modelo de prompt e às suas variáveis. No
└─ id cadeia (de caracteres) O identificador único do modelo de prompt a usar. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis no teu prompt. Os valores de substituição podem ser strings ou outros tipos de entrada de Resposta, como imagens ou ficheiros. No
└─ version cadeia (de caracteres) Versão opcional do modelo de prompt. No
reasoning objecto Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ effort OpenAI.ReasoningEffort Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
└─ generate_summary enumeração Obsoleto: usa 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
└─ summary 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
estado enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto 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 texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objecto Controla qual (se houver) ferramenta chamada pelo modelo.

none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo tem de chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta incorporada para gerar uma resposta. No
tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 Yes
truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
utilização OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. Yes

AzureSearchChatDataSource

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

Name Tipo Description Required Default
parameters objecto A informação dos parâmetros para controlar a utilização da fonte de dados do Azure Search. Yes
└─ allow_partial_result boolean Se definido como verdadeiro, o sistema permitirá a utilização de resultados de pesquisa parciais e o pedido falhará se todas as consultas parciais falharem. Se não for especificado ou especificado como falso, o pedido falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication objecto No
└─ access_token cadeia (de caracteres) No
└─ key cadeia (de caracteres) No
└─ managed_identity_resource_id cadeia (de caracteres) No
└─ type enumeração
Valores possíveis: access_token		 No
└─ embedding_dependency objecto Representa uma fonte de vetorização que faz chamadas de serviço público contra a implementação de um modelo de embedding do Azure OpenAI. No
└─ authentication AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions O mecanismo de autenticação a usar com a fonte de vetorização baseada no endpoint.
A autenticação endpoint suporta mecanismos de chave API e token de acesso.		 No
└─ deployment_name cadeia (de caracteres) A implementação do modelo de embedding para usar na vetorização. Esta implementação deve existir dentro do mesmo recurso Azure OpenAI que a implementação do modelo utilizado para a conclusão de chats. No
└─ dimensions número inteiro O número de dimensões a solicitar em embeddings.
Apenas suportado em 'text-embedding-3' e modelos posteriores.		 No
└─ endpoint cadeia (de caracteres) Especifica a URL do endpoint de recurso a partir da qual os embeddings devem ser recuperados.
Deve ser no formato seguinte:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
O parâmetro de consulta de versão da API não é permitido.		 No
└─ type enumeração O identificador de tipo, sempre 'integrado' para este tipo de fonte de vetorização.
Valores possíveis: integrated		 No
└─ endpoint cadeia (de caracteres) O caminho de endpoint absoluto para o recurso do Azure Search usar. No
└─ fields_mapping objecto Os mapeamentos de campos a usar com o recurso Azure Search. No
└─ content_fields matriz Os nomes dos campos de índice que devem ser tratados como conteúdo. No
└─ content_fields_separator cadeia (de caracteres) O padrão separador que os campos de conteúdo devem usar. No
└─ filepath_field cadeia (de caracteres) O nome do campo índice a usar como caminho de ficheiro. No
└─ image_vector_fields matriz Os nomes dos campos que representam dados vetoriais de imagem. No
└─ title_field cadeia (de caracteres) O nome do campo índice a usar como título. No
└─ url_field cadeia (de caracteres) O nome do campo índice a usar como URL. No
└─ vector_fields matriz Os nomes dos campos que representam dados vetoriais. No
└─ filter cadeia (de caracteres) Um filtro para aplicar à pesquisa. No
└─ in_scope boolean Se as consultas devem ser restringidas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades do contexto de saída a incluir na resposta.
Por defeito, serão solicitadas citações e intenções.		 No ['citations', 'intent']
└─ index_name cadeia (de caracteres) O nome do índice a usar, conforme especificado no recurso de pesquisa do Azure. No
└─ max_search_queries número inteiro O número máximo de consultas reescritas que devem ser enviadas ao fornecedor de pesquisa para uma única mensagem de utilizador.
Por defeito, o sistema fará uma determinação automática.		 No
└─ query_type enumeração O tipo de consulta para o recurso Azure Search a utilizar.
Valores possíveis: simple, semantic, vector, vector_simple_hybrid, vector_semantic_hybrid		 No
└─ semantic_configuration cadeia (de caracteres) Configuração semântica adicional para a consulta. No
└─ strictness número inteiro A rigidez configurada do filtro de relevância de pesquisa.
Maior rigor aumenta a precisão, mas reduz a recordação da resposta.		 No
└─ top_n_documents número inteiro O número configurado de documentos a destacar na consulta. No
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 utilizador contém vários parâmetros que descrevem a própria aplicação e o utilizador final que interage com a aplicação. Estes campos ajudam as suas equipas de operações de segurança a investigar e mitigar incidentes de segurança, fornecendo uma abordagem abrangente para proteger as suas aplicações de IA. Saiba mais sobre como proteger aplicações de IA usando Microsoft Defender para a Cloud.

Name Tipo Description Required Default
application_name cadeia (de caracteres) O nome da candidatura. Informações pessoais sensíveis não devem ser incluídas neste campo. No
end_user_id cadeia (de caracteres) Este identificador é o Microsoft Entra ID (anteriormente Azure Active Directory), ID de objeto de utilizador, usado para autenticar utilizadores finais dentro da aplicação de IA generativa. Informações pessoais sensíveis não devem ser incluídas neste campo. No
end_user_tenant_id cadeia (de caracteres) O ID de tenant da Microsoft 365 a que o utilizador final pertence. É obrigatório quando a aplicação de IA generativa é multiinquilino. No
source_ip cadeia (de caracteres) Captura o endereço IP do cliente original. No

ChatCompletionMessageToolCallsItem

As chamadas de ferramenta geradas pelo modelo, como chamadas de funções.

Conjunto de: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name Tipo Description Required Default
height número inteiro O auge do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes
modelo cadeia (de caracteres) O nome da implementação a usar para este pedido. Yes
n_seconds número inteiro A duração do trabalho de geração de vídeo. Deve ser entre 1 e 20 segundos. No 5
n_variants número inteiro O número de vídeos a criar como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
avisar cadeia (de caracteres) O tema para este trabalho de geração de vídeo. Yes
width número inteiro A largura do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes

CreateVideoGenerationWithMediaRequestMultiPart

As propriedades de um pedido de trabalho de geração de vídeo com ficheiros multimédia.

Name Tipo Description Required Default
files matriz Yes
height número inteiro O auge do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes
inpaint_items matriz Itens opcionais de pintura para este trabalho de geração de vídeo. No
modelo cadeia (de caracteres) O nome da implementação a usar para este pedido. Yes
n_seconds número inteiro A duração do trabalho de geração de vídeo. Deve ser entre 1 e 20 segundos. No 5
n_variants número inteiro O número de vídeos a criar como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
avisar cadeia (de caracteres) O tema para este trabalho de geração de vídeo. Yes
width número inteiro A largura do vídeo. São suportadas as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080, tanto em orientação paisagem como retrato. Yes

CropBounds

O recorte para um item de pintura. Isto especifica a área do elemento de suporte que deve ser usada para a pintura.

Name Tipo Description Required Default
bottom_fraction number O limite inferior da caixa de recorte especificava uma fração da altura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do material original do suporte. No 1
left_fraction number O limite esquerdo da caixa de cortes especificava uma fração da largura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do elemento original do suporte. No 0
right_fraction number O limite direito da caixa de recorte especificava uma fração da largura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do elemento original do suporte. No 1
top_fraction number O limite superior da caixa de cortes especificado como fração da altura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do material original do suporte. No 0

ElasticsearchChatDataSource

Name Tipo Description Required Default
parameters objecto A informação dos parâmetros serve para controlar o uso da fonte de dados Elasticsearch. Yes
└─ allow_partial_result boolean Se definido como verdadeiro, o sistema permitirá a utilização de resultados de pesquisa parciais e o pedido falhará se todas as consultas parciais falharem. Se não for especificado ou especificado como falso, o pedido falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication objecto No
└─ encoded_api_key cadeia (de caracteres) No
└─ key cadeia (de caracteres) No
└─ key_id cadeia (de caracteres) No
└─ type enumeração
Valores possíveis: encoded_api_key		 No
└─ embedding_dependency AzureChatDataSourceVectorizationSource Uma representação de uma fonte de vetorização de dados utilizável como recurso de embedding com uma fonte de dados. No
└─ endpoint cadeia (de caracteres) No
└─ fields_mapping objecto No
└─ content_fields matriz No
└─ content_fields_separator cadeia (de caracteres) No
└─ filepath_field cadeia (de caracteres) No
└─ title_field cadeia (de caracteres) No
└─ url_field cadeia (de caracteres) No
└─ vector_fields matriz No
└─ in_scope boolean Se as consultas devem ser restringidas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades do contexto de saída a incluir na resposta.
Por defeito, serão solicitadas citações e intenções.		 No ['citations', 'intent']
└─ index_name cadeia (de caracteres) No
└─ max_search_queries número inteiro O número máximo de consultas reescritas que devem ser enviadas ao fornecedor de pesquisa para uma única mensagem de utilizador.
Por defeito, o sistema fará uma determinação automática.		 No
└─ query_type enumeração
Valores possíveis: simple, vector		 No
└─ strictness número inteiro A rigidez configurada do filtro de relevância de pesquisa.
Maior rigor aumenta a precisão, mas reduz a recordação da resposta.		 No
└─ top_n_documents número inteiro O número configurado de documentos a destacar na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre 'elasticsearch'.
Valores possíveis: elasticsearch		 Yes

InpaintItem

Um item de pintura para um trabalho de geração de vídeo. Isto especifica o elemento de suporte que deve ser usado para a pintura na geração de vídeo.

Name Tipo Description Required Default
crop_bounds objecto O recorte para um item de pintura.
Isto especifica a área do elemento de suporte que deve ser usada para a pintura.		 No
└─ bottom_fraction number O limite inferior da caixa de recorte especificava uma fração da altura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do material original do suporte. No 1
└─ left_fraction number O limite esquerdo da caixa de cortes especificava uma fração da largura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do elemento original do suporte. No 0
└─ right_fraction number O limite direito da caixa de recorte especificava uma fração da largura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do elemento original do suporte. No 1
└─ top_fraction number O limite superior da caixa de cortes especificado como fração da altura do elemento original do suporte. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do material original do suporte. No 0
file_name cadeia (de caracteres) O nome do ficheiro do item de multimédia. Deve corresponder ao nome do ficheiro de um anexo neste pedido. Yes
frame_index número inteiro O índice de frames deste artigo de media. Isto especifica o frame inicial no vídeo gerado resultante para este item de pintura. Yes 0
tipo objecto O tipo do objeto de pintura. Yes

JobStatus

O estado de um trabalho de geração de vídeo.

Property Value
Description O estado de um trabalho de geração de vídeo.
Type cadeia (de caracteres)
Values preprocessing
queued
running
processing
cancelled
succeeded
failed

MediaItemType

O tipo do objeto de pintura.

Property Value
Description O tipo do objeto de pintura.
Type cadeia (de caracteres)
Values image

MongoDBChatDataSource

Name Tipo Description Required Default
parameters objecto A informação dos parâmetros para controlar a utilização da fonte de dados do MongoDB. Yes
└─ allow_partial_result boolean Se definido como verdadeiro, o sistema permitirá a utilização de resultados de pesquisa parciais e o pedido falhará se todas as consultas parciais falharem. Se não for especificado ou especificado como falso, o pedido falhará se qualquer consulta de pesquisa falhar. No False
└─ app_name cadeia (de caracteres) O nome da aplicação MongoDB. No
└─ authentication objecto No
└─ password cadeia (de caracteres) No
└─ type enumeração
Valores possíveis: username_and_password		 No
└─ username cadeia (de caracteres) No
└─ collection_name cadeia (de caracteres) O nome da coleção MongoDB. No
└─ database_name cadeia (de caracteres) O nome da base de dados MongoDB. No
└─ embedding_dependency objecto Representa uma fonte de vetorização que faz chamadas de serviço público contra a implementação de um modelo de embedding do Azure OpenAI. No
└─ authentication AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions O mecanismo de autenticação a usar com a fonte de vetorização baseada no endpoint.
A autenticação endpoint suporta mecanismos de chave API e token de acesso.		 No
└─ deployment_name cadeia (de caracteres) A implementação do modelo de embedding para usar na vetorização. Esta implementação deve existir dentro do mesmo recurso Azure OpenAI que a implementação do modelo utilizado para a conclusão de chats. No
└─ dimensions número inteiro O número de dimensões a solicitar em embeddings.
Apenas suportado em 'text-embedding-3' e modelos posteriores.		 No
└─ endpoint cadeia (de caracteres) Especifica a URL do endpoint de recurso a partir da qual os embeddings devem ser recuperados.
Deve ser no formato seguinte:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
O parâmetro de consulta de versão da API não é permitido.		 No
└─ type enumeração O identificador de tipo, sempre 'deployment_name' para este tipo de fonte de vetorização.
Valores possíveis: deployment_name		 No
└─ endpoint cadeia (de caracteres) O nome do endpoint do cluster MongoDB. No
└─ fields_mapping objecto Mapeamentos de campos para aplicar aos dados usados pela fonte de dados do MongoDB.
Note que o mapeamento de conteúdo e de campos vetoriais é necessário para o MongoDB.		 No
└─ content_fields matriz No
└─ content_fields_separator cadeia (de caracteres) No
└─ filepath_field cadeia (de caracteres) No
└─ title_field cadeia (de caracteres) No
└─ url_field cadeia (de caracteres) No
└─ vector_fields matriz No
└─ in_scope boolean Se as consultas devem ser restringidas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades do contexto de saída a incluir na resposta.
Por defeito, serão solicitadas citações e intenções.		 No ['citations', 'intent']
└─ index_name cadeia (de caracteres) O nome do índice MongoDB. No
└─ max_search_queries número inteiro O número máximo de consultas reescritas que devem ser enviadas ao fornecedor de pesquisa para uma única mensagem de utilizador.
Por defeito, o sistema fará uma determinação automática.		 No
└─ strictness número inteiro A rigidez configurada do filtro de relevância de pesquisa.
Maior rigor aumenta a precisão, mas reduz a recordação da resposta.		 No
└─ top_n_documents número inteiro O número configurado de documentos a destacar na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre 'mongo_db'.
Valores possíveis: mongo_db		 Yes

OpenAI.Annotation

Discriminador para OpenAI.Annotation

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

Type Value Schema
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
Name Tipo Description Required Default
tipo OpenAI.AnnotationType Yes

OpenAI.AnnotationFileCitation

Uma citação para um ficheiro.

Name Tipo Description Required Default
file_id cadeia (de caracteres) O ID do ficheiro. Yes
filename cadeia (de caracteres) O nome do ficheiro citado. Yes
indexar número inteiro O índice do ficheiro na lista de ficheiros. Yes
tipo enumeração O tipo da citação do ficheiro. Sempre file_citation.
Valores possíveis: file_citation		 Yes

OpenAI.AnnotationFilePath

Um caminho para um ficheiro.

Name Tipo Description Required Default
file_id cadeia (de caracteres) O ID do ficheiro. Yes
indexar número inteiro O índice do ficheiro na lista de ficheiros. Yes
tipo enumeração O tipo do caminho do ficheiro. Sempre file_path.
Valores possíveis: file_path		 Yes

OpenAI.AnnotationType

Property Value
Type cadeia (de caracteres)
Values file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

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

Name Tipo Description Required Default
end_index número inteiro O índice do último carácter da citação do URL na mensagem. Yes
start_index número inteiro O índice do primeiro carácter da citação URL na mensagem. Yes
title cadeia (de caracteres) O título do recurso web. Yes
tipo enumeração O tipo da citação do URL. Sempre url_citation.
Valores possíveis: url_citation		 Yes
url cadeia (de caracteres) A URL do recurso web. Yes

OpenAI.ApproximateLocation

Name Tipo Description Required Default
city cadeia (de caracteres) No
country cadeia (de caracteres) No
região cadeia (de caracteres) No
timezone cadeia (de caracteres) No
tipo enumeração
Valores possíveis: approximate		 Yes

OpenAI.AudioResponseFormat

O formato da saída, numa destas opções: json, text, srt, verbose_json, ou vtt. Para gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, e gpt-4o-mini-transcribe-2025-12-15. O único formato suportado é json.

Property Value
Description O formato da saída, numa destas opções: json, text, srt, verbose_json, ou vtt. Para gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe, e gpt-4o-mini-transcribe-2025-12-15. O único formato suportado é json.
Type cadeia (de caracteres)
Values json
text
srt
verbose_json
vtt

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.

Name Tipo Description Required Default
tipo enumeração Sempre auto.
Valores possíveis: auto		 Yes

OpenAI.ChatCompletionFunctionCallOption

Especificar uma função particular via {"name": "my_function"} obriga o modelo a chamar essa função.

Name Tipo Description Required Default
name cadeia (de caracteres) O nome da função a chamar. Yes

OpenAI.ChatCompletionFunctions

Name Tipo Description Required Default
description cadeia (de caracteres) Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função. No
name cadeia (de caracteres) O nome da função a ser chamada. Devem ser de a z, de A a Z, de 0 a 9, ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
parameters Os parâmetros que a função aceita, 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.		 No

OpenAI.ChatCompletionMessageAudioChunk

Name Tipo Description Required Default
dados cadeia (de caracteres) No
expires_at número inteiro No
id cadeia (de caracteres) No
transcrição cadeia (de caracteres) No

OpenAI.ChatCompletionMessageToolCall

Name Tipo Description Required Default
função objecto A função que o modelo chamou. Yes
└─ arguments cadeia (de caracteres) Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode alucinar parâmetros não definidos pelo seu esquema de funções. Valida os argumentos no teu código antes de chamar a tua função. No
└─ name cadeia (de caracteres) O nome da função a chamar. No
id cadeia (de caracteres) O ID da chamada de ferramenta. Yes
tipo enumeração O tipo da ferramenta. Atualmente, só function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name Tipo Description Required Default
função objecto No
└─ arguments cadeia (de caracteres) Os argumentos para chamar a função com, conforme gerado pelo modelo em formato JSON. Note que o modelo nem sempre gera JSON válido e pode alucinar parâmetros não definidos pelo seu esquema de funções. Valida os argumentos no teu código antes de chamar a tua função. No
└─ name cadeia (de caracteres) O nome da função a chamar. No
id cadeia (de caracteres) O ID da chamada de ferramenta. No
indexar número inteiro Yes
tipo enumeração O tipo da ferramenta. Atualmente, só function é suportado.
Valores possíveis: function		 No

OpenAI.ChatCompletionNamedToolChoice

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

Name Tipo Description Required Default
função objecto Yes
└─ name cadeia (de caracteres) O nome da função a chamar. No
tipo enumeração O tipo da ferramenta. Atualmente, só function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionRequestAssistantMessage

Mensagens enviadas pelo modelo em resposta a mensagens do utilizador.

Name Tipo Description Required Default
audio objecto Dados sobre uma resposta áudio anterior do modelo. No
└─ id cadeia (de caracteres) Identificador único para uma resposta áudio anterior do modelo. No
conteúdo String ou array No
function_call objecto Descontinuado e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, tal como gerada pelo modelo. No
└─ arguments cadeia (de caracteres) No
└─ name cadeia (de caracteres) No
name cadeia (de caracteres) Um nome opcional para o participante. Fornece a informação do modelo para diferenciar entre participantes do mesmo papel. No
refusal cadeia (de caracteres) A mensagem de recusa do assistente. No
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ções. No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name Tipo Description Required Default
refusal 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 A parte do tipo de conteúdo.
Valores possíveis: refusal		 Yes

OpenAI.ChatCompletionRequestDeveloperMessage

Instruções fornecidas pelo programador que o modelo deve seguir, independentemente das mensagens enviadas pelo utilizador. Nos modelos O1 e mais recentes, developer as mensagens substituem as anteriores system .

Name Tipo Description Required Default
conteúdo String ou array Yes
name cadeia (de caracteres) Um nome opcional para o participante. Fornece a informação do modelo para diferenciar entre participantes do mesmo papel. No
função enumeração O papel do autor das mensagens, neste caso developer.
Valores possíveis: developer		 Yes

OpenAI.ChatCompletionRequestFunctionMessage

Name Tipo Description Required Default
conteúdo cadeia (de caracteres) O conteúdo da mensagem funcional. Yes
name cadeia (de caracteres) O nome da função a chamar. 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 utiliza a propriedade role para discriminar entre diferentes tipos:

Type Value Schema
system OpenAI.ChatCompletionRequestSystemMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
user OpenAI.ChatCompletionRequestUserMessage
assistant OpenAI.ChatCompletionRequestAssistantMessage
tool OpenAI.ChatCompletionRequestToolMessage
function OpenAI.ChatCompletionRequestFunctionMessage
Name Tipo Description Required Default
conteúdo String ou array No
função objecto O papel do autor de uma mensagem Yes

OpenAI.ChatCompletionRequestMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestMessageContentPart

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

Type Value Schema
text OpenAI.ChatCompletionRequestMessageContentPartText
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
file OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
Name Tipo Description Required Default
tipo OpenAI.ChatCompletionRequestMessageContentPartType Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name Tipo Description Required Default
input_audio objecto Yes
└─ data cadeia (de caracteres) Dados de áudio codificados em Base64. No
└─ format enumeração O formato dos dados de áudio codificados. Atualmente suporta "wav" e "mp3".
Valores possíveis: wav, mp3		 No
tipo enumeração A parte do tipo de conteúdo. Sempre input_audio.
Valores possíveis: input_audio		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name Tipo Description Required Default
ficheiro objecto Yes
└─ file_data cadeia (de caracteres) O base64 codificava dados de ficheiro, usados ao passar o ficheiro para o modelo como uma string. No
└─ file_id cadeia (de caracteres) O ID de um ficheiro carregado para usar como entrada. No
└─ filename cadeia (de caracteres) O nome do ficheiro, usado ao passar o ficheiro para o modelo como uma string. No
tipo enumeração A parte do tipo de conteúdo. Sempre file.
Valores possíveis: file		 Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name Tipo Description Required Default
image_url objecto Yes
└─ detail enumeração Especifica o nível de detalhe da imagem.
Valores possíveis: auto, low, high		 No
└─ url cadeia (de caracteres) Ou uma URL da imagem ou os dados da imagem codificada base64. No
tipo enumeração A parte do tipo de conteúdo.
Valores possíveis: image_url		 Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name Tipo Description Required Default
refusal cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. Yes
tipo enumeração A parte do tipo de conteúdo.
Valores possíveis: refusal		 Yes

OpenAI.ChatCompletionRequestMessageContentPartText

Name Tipo Description Required Default
enviar SMS cadeia (de caracteres) O conteúdo do texto. Yes
tipo enumeração A parte do tipo de conteúdo.
Valores possíveis: text		 Yes

OpenAI.ChatCompletionRequestMessageContentPartType

Property Value
Type cadeia (de caracteres)
Values text
file
input_audio
image_url
refusal

OpenAI.ChatCompletionRequestSystemMessage

Instruções fornecidas pelo programador que o modelo deve seguir, independentemente das mensagens enviadas pelo utilizador. Com modelos O1 e mais recentes, use developer mensagens para este propósito.

Name Tipo Description Required Default
conteúdo String ou array Yes
name cadeia (de caracteres) Um nome opcional para o participante. Fornece a informação do modelo para diferenciar entre participantes do mesmo papel. No
função enumeração O papel do autor das mensagens, neste caso system.
Valores possíveis: system		 Yes

OpenAI.ChatCompletionRequestSystemMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Name Tipo Description Required Default
conteúdo String ou array 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á a responder. Yes

OpenAI.ChatCompletionRequestToolMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

Name Tipo Description Required Default
conteúdo String ou array Yes
name cadeia (de caracteres) Um nome opcional para o participante. Fornece a informação do modelo para diferenciar entre participantes do mesmo papel. No
função enumeração O papel do autor das mensagens, neste caso user.
Valores possíveis: user		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Name Tipo Description Required Default
ficheiro objecto Yes
└─ file_data cadeia (de caracteres) O base64 codificava dados de ficheiro, usados ao passar o ficheiro para o modelo como uma string. No
└─ file_id cadeia (de caracteres) O ID de um ficheiro carregado para usar como entrada. No
└─ filename cadeia (de caracteres) O nome do ficheiro, usado ao passar o ficheiro para o modelo como uma string. No
image_url objecto Yes
└─ detail enumeração Especifica o nível de detalhe da imagem.
Valores possíveis: auto, low, high		 No
└─ url cadeia (de caracteres) Ou uma URL da imagem ou os dados da imagem codificada base64. No
input_audio objecto Yes
└─ data cadeia (de caracteres) Dados de áudio codificados em Base64. No
└─ format enumeração O formato dos dados de áudio codificados. Atualmente suporta "wav" e "mp3".
Valores possíveis: wav, mp3		 No
enviar SMS cadeia (de caracteres) O conteúdo do texto. Yes
tipo enumeração A parte do tipo de conteúdo. Sempre file.
Valores possíveis: file		 Yes

OpenAI.ChatCompletionRole

O papel do autor de uma mensagem

Property Value
Description O papel do autor de uma mensagem
Type cadeia (de caracteres)
Values system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

Opções para resposta ao streaming. Só define isto quando defines stream: true.

Name Tipo Description Required Default
include_usage boolean Se ativado, um segmento adicional será transmitido antes da data: [DONE] mensagem. O usage campo neste bloco mostra as estatísticas de utilização do token para todo o pedido, e o choices campo será sempre um array vazio.

Todos os outros chunks também incluirão um usage campo, mas com valor nulo. NOTA: Se o stream for interrompido, pode não receber o bloco final de utilização que contém o total de utilização do token para o pedido.		 No

OpenAI.ChatCompletionStreamResponseDelta

Um delta de conclusão do chat gerado pelas respostas do modelo em streaming.

Name Tipo Description Required Default
audio objecto No
└─ data cadeia (de caracteres) No
└─ expires_at número inteiro No
└─ id cadeia (de caracteres) No
└─ transcript cadeia (de caracteres) No
conteúdo cadeia (de caracteres) O conteúdo da mensagem do bloco. No
function_call objecto Descontinuado e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, tal como gerada pelo modelo. No
└─ arguments cadeia (de caracteres) No
└─ name cadeia (de caracteres) No
refusal cadeia (de caracteres) A mensagem de recusa gerada pelo modelo. No
função objecto O papel do autor de uma mensagem No
tool_calls matriz No

OpenAI.ChatCompletionTokenLogprob

Name Tipo Description Required Default
bytes matriz Uma lista de inteiros que representa a representação UTF-8 bytes do token. Útil em casos em que os caracteres são representados por múltiplos tokens e as suas representações em bytes têm de ser combinadas para gerar a representação correta do texto. Pode ser null se não houver representação em bytes para o token. Yes
logprob number A probabilidade logarítmica deste token, se estiver dentro dos 20 tokens mais prováveis. Caso contrário, o valor -9999.0 é usado para indicar que o token é muito improvável. Yes
token cadeia (de caracteres) The token. Yes
top_logprobs matriz Lista dos tokens mais prováveis e a sua probabilidade logarítmica, nesta posição do token. Em casos raros, pode haver menos do que o número de pedidos top_logprobs devolvidos. Yes

OpenAI.ChatCompletionTool

Name Tipo Description Required Default
função OpenAI.FunctionObject Yes
tipo enumeração O tipo da ferramenta. Atualmente, só function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionToolChoiceOption

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

none é o padrão quando não há ferramentas presentes. auto é o padrão se houver ferramentas presentes.

Name Tipo Description Required Default
função objecto Yes
└─ name cadeia (de caracteres) O nome da função a chamar. No
tipo enumeração O tipo da ferramenta. Atualmente, só function é suportado.
Valores possíveis: function		 Yes

OpenAI.ChatOutputPrediction

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

Discriminador para OpenAI.ChatOutputPrediction

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

Type Value Schema
content OpenAI.ChatOutputPredictionContent
Name Tipo Description Required Default
tipo OpenAI.ChatOutputPredictionType Yes

OpenAI.ChatOutputPredictionContent

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

Name Tipo Description Required Default
conteúdo String ou array Yes
tipo enumeração O tipo de conteúdo previsto que quer fornecer. Este tipo é atualmente sempre content.
Valores possíveis: content		 Yes

OpenAI.ChatOutputPredictionType

Property Value
Type cadeia (de caracteres)
Values content

OpenAI.ChunkingStrategyRequestParam

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

Discriminador para OpenAI.ChunkingStrategyRequestParam

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

Type Value Schema
static OpenAI.StaticChunkingStrategyRequestParam
Name Tipo Description Required Default
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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
other OpenAI.OtherChunkingStrategyResponseParam
static OpenAI.StaticChunkingStrategyResponseParam
Name Tipo Description Required Default
tipo enumeração
Valores possíveis: static, other		 Yes

OpenAI.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

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

Type Value Schema
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
Name Tipo Description Required Default
tipo OpenAI.CodeInterpreterOutputType Yes

OpenAI.CodeInterpreterOutputImage

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

Name Tipo Description Required Default
tipo enumeração O tipo de saída. Always 'image'.
Valores possíveis: image		 Yes
url cadeia (de caracteres) A URL da imagem é saída do interpretador de código. Yes

OpenAI.CodeInterpreterOutputLogs

Os logs são gerados pelo interpretador de código.

Name Tipo Description Required Default
registos cadeia (de caracteres) Os logs são gerados pelo interpretador de código. Yes
tipo enumeração O tipo de saída. Always 'logs'.
Valores possíveis: logs		 Yes

OpenAI.CodeInterpreterOutputType

Property Value
Type cadeia (de caracteres)
Values logs
image

OpenAI.CodeInterpreterTool

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

Name Tipo Description Required Default
contentor objecto Configuração para um contentor interpretador de código. Opcionalmente, especifique os IDs dos ficheiros para executar o código. Yes
└─ file_ids matriz Uma lista opcional de ficheiros carregados para disponibilizar ao seu código. No
└─ type enumeração Sempre auto.
Valores possíveis: auto		 No
tipo enumeração O tipo da ferramenta interpretadora de código. Sempre code_interpreter.
Valores possíveis: code_interpreter		 Yes

OpenAI.CodeInterpreterToolAuto

Configuração para um contentor interpretador de código. Opcionalmente, especifique os IDs dos ficheiros para executar o código.

Name Tipo Description Required Default
file_ids matriz Uma lista opcional de ficheiros carregados para disponibilizar ao seu código. No
tipo enumeração Sempre auto.
Valores possíveis: auto		 Yes

OpenAI.CodeInterpreterToolCallItemParam

Uma chamada de ferramenta para executar código.

Name Tipo Description Required Default
código cadeia (de caracteres) O código a executar, ou nulo se não estiver disponível. Yes
container_id cadeia (de caracteres) O ID do contentor usado para executar o código. Yes
outputs matriz As saídas geradas pelo interpretador de código, como logs ou imagens.
Pode ser nulo se não houver saídas disponíveis.		 Yes
tipo enumeração
Valores possíveis: code_interpreter_call		 Yes

OpenAI.CodeInterpreterToolCallItemResource

Uma chamada de ferramenta para executar código.

Name Tipo Description Required Default
código cadeia (de caracteres) O código a executar, ou nulo se não estiver disponível. Yes
container_id cadeia (de caracteres) O ID do contentor usado para executar o código. Yes
outputs matriz As saídas geradas pelo interpretador de código, como logs ou imagens.
Pode ser nulo se não houver saídas disponíveis.		 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 atributos especificada a um dado valor usando uma operação de comparação definida.

Name Tipo Description Required Default
chave cadeia (de caracteres) A chave para comparar com 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: maior que
- gte: maior ou igual
- lt: menos que
- lte: menor ou igual.
Valores possíveis: eq, ne, gt, gte, lt, lte		 Yes
value string ou número ou booleano Yes

OpenAI.CompletionUsage

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

Name Tipo Description Required Default
completion_tokens número inteiro Número de tokens na conclusão gerada. Yes 0
completion_tokens_details objecto Divisão dos tokens usados numa conclusão. No
└─ accepted_prediction_tokens número inteiro Ao usar Saídas Previstas, o número de tokens na previsão que apareceu na completação. No 0
└─ audio_tokens número inteiro Tokens de entrada de áudio gerados pelo modelo. No 0
└─ reasoning_tokens número inteiro Tokens gerados pelo modelo para raciocínio. No 0
└─ rejected_prediction_tokens número inteiro Ao usar Saídas Previstas, o número de tokens na previsão que não apareceram na conclusão. No entanto, tal como os tokens de raciocínio, estes tokens continuam a ser contados no total de tokens de conclusão para efeitos de faturação, saída e limites de janela de contexto. No 0
prompt_tokens número inteiro Número de tokens no prompt. Yes 0
prompt_tokens_details objecto Divisão dos tokens usados no prompt. No
└─ audio_tokens número inteiro Tokens de entrada de áudio presentes no prompt. No 0
└─ cached_tokens número inteiro Tokens em cache presentes no prompt. No 0
total_tokens número inteiro Número total de tokens usados no pedido (prompt + conclusão). Yes 0

OpenAI.CompoundFilter

Combine múltiplos filtros usando and ou or.

Name Tipo Description Required Default
filters matriz Conjunto 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
click OpenAI.ComputerActionClick
double_click OpenAI.ComputerActionDoubleClick
drag OpenAI.ComputerActionDrag
move OpenAI.ComputerActionMove
screenshot OpenAI.ComputerActionScreenshot
scroll OpenAI.ComputerActionScroll
type OpenAI.ComputerActionTypeKeys
wait OpenAI.ComputerActionWait
keypress OpenAI.ComputerActionKeyPress
Name Tipo Description Required Default
tipo OpenAI.ComputerActionType Yes

OpenAI.ComputerActionClick

Uma ação de clique.

Name Tipo Description Required Default
button enumeração Indica qual botão do rato foi pressionado durante o clique. Uma 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 definida para 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 duplo clique.

Name Tipo Description Required Default
tipo enumeração Especifica o tipo de evento. Para uma ação de duplo clique, esta propriedade está sempre definida 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.ComputerActionDrag

Uma ação de arrasto.

Name Tipo Description Required Default
caminho matriz Um conjunto de coordenadas que representam o caminho da ação de arrasto. As coordenadas aparecerão como um array de objetos, por exemplo{ x: 100, y: 200 }, { x: 200, y: 300 } Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de arrasto, esta propriedade é sempre definida para drag.
Valores possíveis: drag		 Yes

OpenAI.ComputerActionKeyPress

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

Name Tipo Description Required Default
keys matriz A combinação de teclas que o modelo pede para ser pressionada. Trata-se de um array de cadeias, cada uma representando uma tecla. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de pressionar a tecla, esta propriedade é sempre definida para keypress.
Valores possíveis: keypress		 Yes

OpenAI.ComputerActionMove

Uma ação de movimento de rato.

Name Tipo Description Required Default
tipo enumeração Especifica o tipo de evento. Para uma ação de movimento, esta propriedade é sempre definida como move.
Valores possíveis: move		 Yes
x número inteiro A coordenada x para onde se deve mover. Yes
y número inteiro A coordenada Y para onde se deve mover. Yes

OpenAI.ComputerActionScreenshot

Uma ação de captura de ecrã.

Name Tipo Description Required Default
tipo enumeração Especifica o tipo de evento. Para uma ação de captura de ecrã, esta propriedade está sempre definida como screenshot.
Valores possíveis: screenshot		 Yes

OpenAI.ComputerActionScroll

Uma ação de pergaminho.

Name Tipo Description Required Default
scroll_x número inteiro A distância do scroll horizontal. Yes
scroll_y número inteiro A distância do scroll vertical. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de scroll, esta propriedade é sempre definida como scroll.
Valores possíveis: scroll		 Yes
x número inteiro A coordenada x onde ocorreu o scroll. Yes
y número inteiro A coordenada y onde o scroll ocorreu. Yes

OpenAI.ComputerActionType

Property Value
Type cadeia (de caracteres)
Values screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

Uma ação para escrever texto.

Name Tipo Description Required Default
enviar SMS cadeia (de caracteres) O texto para escrever. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de tipo, esta propriedade é sempre definida como type.
Valores possíveis: type		 Yes

OpenAI.ComputerActionWait

Uma ação de espera.

Name Tipo Description Required Default
tipo enumeração Especifica o tipo de evento. Para uma ação de espera, esta propriedade é sempre definida para wait.
Valores possíveis: wait		 Yes

OpenAI.ComputerToolCallItemParam

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

Name Tipo Description Required Default
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 no computador. Yes
tipo enumeração
Valores possíveis: computer_call		 Yes

OpenAI.ComputerToolCallItemResource

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

Name Tipo Description Required Default
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 no computador. Yes
estado enumeração O estado do item. Um de in_progress, completed, ou incomplete. Preenche quando os itens são devolvidos 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
computer_screenshot OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot
Name Tipo Description Required Default
tipo OpenAI.ComputerToolCallOutputItemOutputType Uma imagem de captura de ecrã de computador usada com a ferramenta de uso do computador. Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name Tipo Description Required Default
file_id cadeia (de caracteres) No
image_url cadeia (de caracteres) No
tipo enumeração
Valores possíveis: computer_screenshot		 Yes

OpenAI.ComputerToolCallOutputItemOutputType

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

Property Value
Description Uma imagem de captura de ecrã de computador usada com a ferramenta de uso do computador.
Type cadeia (de caracteres)
Values computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

A saída de uma chamada de ferramenta informática.

Name Tipo Description Required Default
acknowledged_safety_checks matriz As verificações de segurança reportadas pela API que foram reconhecidas pelo programador. No
call_id cadeia (de caracteres) O ID da chamada de ferramenta informática 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 informática.

Name Tipo Description Required Default
acknowledged_safety_checks matriz As verificações de segurança reportadas pela API que foram reconhecidas pelo programador. No
call_id cadeia (de caracteres) O ID da chamada de ferramenta informática que produziu a saída. Yes
output OpenAI.ComputerToolCallOutputItemOutput Yes
estado enumeração O estado do item. Um de in_progress, completed, ou incomplete. Preenche quando os itens são devolvidos 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 no computador.

Name Tipo Description Required Default
código cadeia (de caracteres) O tipo de verificação de segurança pendente. Yes
id cadeia (de caracteres) A identificação da verificação de segurança pendente. Yes
mensagem cadeia (de caracteres) Detalhes sobre a verificação de segurança pendente. Yes

OpenAI.ComputerUsePreviewTool

Uma ferramenta que controla um computador virtual.

Name Tipo Description Required Default
display_height número inteiro A altura do ecrã do computador. Yes
display_width número inteiro A largura do ecrã do computador. Yes
ambiente enumeração O tipo de ambiente informático 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.Coordinate

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

Name Tipo Description Required Default
x número inteiro The x-coordinate. Yes
y número inteiro The y-coordinate. Yes

OpenAI.CreateEmbeddingResponse

Name Tipo Description Required Default
dados matriz A lista de embeddings gerados 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 A informação de utilização do pedido. Yes
└─ prompt_tokens número inteiro O número de fichas usadas pelo prompt. No
└─ total_tokens número inteiro O número total de tokens usados pelo pedido. No

OpenAI.CreateEvalItem

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

Name Tipo Description Required Default
conteúdo string ou OpenAI.EvalItemContent Entradas de texto para o modelo - podem conter cadeias de templates. Yes
função enumeração O papel da entrada da mensagem. Um de user, assistant, system, ou developer.
Valores possíveis: user, assistant, system, developer		 Yes
tipo enumeração O tipo de entrada da mensagem. Sempre message.
Valores possíveis: message		 No

OpenAI.CreateEvalRunRequest

Name Tipo Description Required Default
data_source objecto Yes
└─ type OpenAI.EvalRunDataSourceType No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da corrida. No

OpenAI.CreateFineTuningJobRequest

Valid models:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Name Tipo Description Required Default
hyperparameters objecto Os hiperparâmetros usados para o trabalho de ajuste fino.
Este valor está agora obsoleto em favor de method, e deve ser passado sob o method parâmetro.		 No
└─ batch_size enumeração
Valores possíveis: auto		 No
└─ learning_rate_multiplier enumeração
Valores possíveis: auto		 No
└─ n_epochs enumeração
Valores possíveis: auto		 No
integrations matriz Uma lista de integrações para ativar para o seu trabalho de afinação. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
método OpenAI.FineTuneMethod O método usado para afinações. No
modelo string (ver modelos válidos abaixo) O nome do modelo a afinar. Yes
seed número inteiro A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros seed e job deve produzir os mesmos resultados, mas pode diferir em casos raros.
Se uma semente não for especificada, será gerada uma para si.		 No
suffix cadeia (de caracteres) Uma sequência de até 64 caracteres que será adicionada ao seu nome de modelo afinado.

Por exemplo, um suffix de "nome-modelo-personalizado" produziria um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No None
training_file cadeia (de caracteres) O ID de um ficheiro carregado que contém dados de treino. O seu conjunto de dados deve estar formatado como um ficheiro JSONL. Além disso, deve carregar o seu ficheiro com o propósito fine-tunede .

O conteúdo do ficheiro deve variar dependendo se o modelo usa o formato de chat, completions ou se o método de ajuste fino utiliza o formato de preferência.		 Yes
validation_file cadeia (de caracteres) O ID de um ficheiro carregado que contém dados de validação.

Se fornecer este ficheiro, os dados são usados para gerar métricas de validação periodicamente durante o ajuste fino. Estas métricas podem ser visualizadas no ficheiro de resultados de ajuste fino.
Os mesmos dados não devem estar presentes tanto nos ficheiros de treino como nos de validação.

O seu conjunto de dados deve estar formatado como um ficheiro JSONL. Deve carregar o seu ficheiro com o propósito fine-tunede .		 No

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Type Value Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Name Tipo Description Required Default
tipo string (ver modelos válidos abaixo) Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: wandb		 Yes
wandb objecto Yes
└─ entity cadeia (de caracteres) No
└─ name cadeia (de caracteres) No
└─ project cadeia (de caracteres) No
└─ tags matriz No

OpenAI.CreateVectorStoreFileBatchRequest

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) ficheiro(s). Se não estiver definido, vou usar a auto estratégia. No
file_ids matriz Uma lista de IDs de ficheiros que o armazenamento vetorial deve usar. Útil para ferramentas que file_search permitem aceder a ficheiros. Yes

OpenAI.CreateVectorStoreFileRequest

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de fragmentação usada para fragmentar o(s) ficheiro(s). Se não estiver definido, vou usar a auto estratégia. No
file_id cadeia (de caracteres) Um ID de ficheiro que a loja vetorial deve usar. Útil para ferramentas que file_search permitem aceder a ficheiros. Yes

OpenAI.CreateVectorStoreRequest

Name Tipo Description Required Default
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. No
└─ static OpenAI.StaticChunkingStrategy No
└─ type enumeração Sempre static.
Valores possíveis: static		 No
expires_after OpenAI.VectorStoreExpirationAfter A política de expiração para uma loja vetorial. No
file_ids matriz Uma lista de IDs de ficheiros que o armazenamento vetorial deve usar. Útil para ferramentas que file_search permitem aceder a ficheiros. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da loja vetorial. No

OpenAI.DeleteFileResponse

Name Tipo Description Required Default
deleted boolean Yes
id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: file		 Yes

OpenAI.DeleteVectorStoreFileResponse

Name Tipo Description Required Default
deleted boolean Yes
id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: vector_store.file.deleted		 Yes

OpenAI.DeleteVectorStoreResponse

Name Tipo Description Required Default
deleted boolean Yes
id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: vector_store.deleted		 Yes

OpenAI.Embedding

Representa um vetor de embedding devolvido pelo endpoint de embedding.

Name Tipo Description Required Default
embedding array ou string Yes
indexar número inteiro O índice do embedding na lista de embeddings. Yes
objecto enumeração O tipo de objeto, que é sempre "embedding".
Valores possíveis: embedding		 Yes

OpenAI.Eval

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

  • Melhorar a qualidade do meu chatbot
  • Veja como o meu chatbot lida bem com o apoio ao cliente
  • Verifica se o o4-mini é melhor para o meu caso de uso do que o gpt-4o
Name Tipo Description Required Default
created_at número inteiro O carimbo temporal do Unix (em segundos) indica quando a avaliação foi criada. Yes
data_source_config objecto Yes
└─ type OpenAI.EvalDataSourceConfigType No
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ção adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
name cadeia (de caracteres) O nome da avaliação. Yes
objecto enumeração O tipo de objeto.
Valores possíveis: eval		 Yes
testing_criteria matriz Uma lista de critérios de teste. Yes None

OpenAI.EvalApiError

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

Name Tipo Description Required Default
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.

Name Tipo Description Required Default
input_messages objecto No
└─ item_reference cadeia (de caracteres) Uma referência a uma variável no item namespace. Ie, "item.input_trajectory" No
└─ template matriz Uma lista de mensagens de chat que formam o prompt ou contexto. Pode incluir referências de variáveis ao item namespace, ou seja, {{item.name}}. No
└─ type enumeração O tipo de mensagens de entrada. Sempre item_reference.
Valores possíveis: item_reference		 No
modelo cadeia (de caracteres) O nome do modelo a usar para gerar completões (por exemplo, "o3-mini"). No
sampling_params AzureEvalAPICompletionsSamplingParams No
origem objecto Yes
└─ content matriz O conteúdo do ficheiro jsonl. No
└─ created_after número inteiro Um carimbo temporal Unix opcional para filtrar itens criados após esse período. No
└─ created_before número inteiro Um carimbo temporal Unix opcional para filtrar itens criados antes desse período. No
└─ id cadeia (de caracteres) O identificador do ficheiro. No
└─ limit número inteiro Um número máximo opcional de itens para devolver. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ model cadeia (de caracteres) Um modelo opcional para filtrar (por exemplo, 'gpt-4o'). No
└─ type enumeração O tipo de fonte. Sempre stored_completions.
Valores possíveis: stored_completions		 No
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 na avaliação é executado. Este esquema é usado para definir a forma dos dados que serão:

  • Usado para definir os seus critérios de teste e
  • Que dados são necessários ao criar uma execução
Name Tipo Description Required Default
include_sample_schema boolean Se a avaliação deve esperar que preencha o namespace da amostra (ou seja, gerando respostas a partir da sua fonte de dados)? No False
item_schema 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 dos seus item e, opcionalmente sample , dos namespaces. O esquema de resposta define a forma dos dados que será:

  • Usado para definir os seus critérios de teste e
  • Que dados são necessários ao criar uma execução
Name Tipo Description Required Default
esquema objecto O esquema json para os itens da fonte de dados executados.
Aprenda aqui a construir esquemas JSON.		 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
custom OpenAI.EvalCustomDataSourceConfigParams
logs OpenAI.EvalLogsDataSourceConfigParams
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigParams
Name Tipo Description Required Default
tipo OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigResource

Discriminador para OpenAI.EvalDataSourceConfigResource

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

Type Value Schema
custom OpenAI.EvalCustomDataSourceConfigResource
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs OpenAI.EvalLogsDataSourceConfigResource
Name Tipo Description Required Default
tipo OpenAI.EvalDataSourceConfigType Yes

OpenAI.EvalDataSourceConfigType

Property Value
Type cadeia (de caracteres)
Values custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

Um objeto LabelModelGrader que utiliza um modelo para atribuir etiquetas a cada item da avaliação.

Name Tipo Description Required Default
dados introduzidos matriz Uma lista de mensagens de chat que formam o prompt ou contexto. Pode incluir referências de variáveis ao item namespace, ou seja, {{item.name}}. Yes
labels matriz As etiquetas a classificar para cada item na avaliação. Yes
modelo cadeia (de caracteres) O modelo a usar para a avaliação. Deve suportar saídas estruturadas. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
passing_labels matriz As etiquetas que indicam um resultado de aprovação. 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

Name Tipo Description Required Default
dados introduzidos matriz Yes
labels matriz Os rótulos a atribuir a cada item na avaliação. Yes
modelo cadeia (de caracteres) O modelo a usar para a avaliação. Deve suportar saídas estruturadas. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
passing_labels matriz As etiquetas que indicam um resultado de aprovação. 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
label_model OpenAI.EvalGraderLabelModelParams
string_check OpenAI.EvalGraderStringCheckParams
text_similarity OpenAI.EvalGraderTextSimilarityParams
python OpenAI.EvalGraderPythonParams
score_model OpenAI.EvalGraderScoreModelParams
Name Tipo Description Required Default
tipo OpenAI.GraderType Yes

OpenAI.EvalGraderPythonParams

Name Tipo Description Required Default
image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
name cadeia (de caracteres) O nome do avaliador. Yes
pass_threshold number O limiar para a pontuação. No
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

Name Tipo Description Required Default
image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
name cadeia (de caracteres) O nome do avaliador. Yes
pass_threshold number O limiar para a pontuação. No
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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
label_model OpenAI.EvalGraderLabelModelResource
text_similarity OpenAI.EvalGraderTextSimilarityResource
python OpenAI.EvalGraderPythonResource
score_model OpenAI.EvalGraderScoreModelResource
Name Tipo Description Required Default
tipo OpenAI.GraderType Yes

OpenAI.EvalGraderScoreModelParams

Name Tipo Description Required Default
dados introduzidos matriz O texto de entrada. Isto pode incluir cadeias de templates. Yes
modelo cadeia (de caracteres) O modelo a usar para a avaliação. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
pass_threshold number O limiar para a pontuação. No
intervalo matriz A amplitude da partitura. Por defeito, é [0, 1]. No
sampling_params Os parâmetros de amostragem para o modelo. No
tipo enumeração O tipo de objeto, que é sempre score_model.
Valores possíveis: score_model		 Yes

OpenAI.EvalGraderScoreModelResource

Name Tipo Description Required Default
dados introduzidos matriz O texto de entrada. Isto pode incluir cadeias de templates. Yes
modelo cadeia (de caracteres) O modelo a usar para a avaliação. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
pass_threshold number O limiar para a pontuação. No
intervalo matriz A amplitude da partitura. Por defeito, é [0, 1]. No
sampling_params Os parâmetros de amostragem para o modelo. No
tipo enumeração O tipo de objeto, que é sempre score_model.
Valores possíveis: score_model		 Yes

OpenAI.EvalGraderStringCheckParams

Name Tipo Description Required Default
dados introduzidos cadeia (de caracteres) O texto de entrada. Isto pode incluir cadeias de templates. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
operação enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Yes
referenciar cadeia (de caracteres) O texto de referência. Isto pode incluir cadeias de templates. Yes
tipo enumeração O tipo de objeto, que é sempre string_check.
Valores possíveis: string_check		 Yes

OpenAI.EvalGraderTextSimilarityParams

Name Tipo Description Required Default
evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 Yes
dados introduzidos cadeia (de caracteres) O texto a ser avaliado. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
pass_threshold number O limiar para a pontuação. Yes
referenciar cadeia (de caracteres) O texto a ser avaliado. Yes
tipo enumeração O tipo de avaliador.
Valores possíveis: text_similarity		 Yes

OpenAI.EvalGraderTextSimilarityResource

Name Tipo Description Required Default
evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 Yes
dados introduzidos cadeia (de caracteres) O texto a ser avaliado. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
pass_threshold number O limiar para a pontuação. Yes
referenciar cadeia (de caracteres) O texto a ser avaliado. Yes
tipo enumeração O tipo de avaliador.
Valores possíveis: text_similarity		 Yes

OpenAI.EvalItem

Uma mensagem introduzida no modelo com um papel que indica a instrução seguindo a hierarquia. As instruções dadas com o developer papel ou system têm prioridade sobre as instruções dadas com o user papel. Presume-se que as mensagens com o assistant papel tenham sido geradas pelo modelo em interações anteriores.

Name Tipo Description Required Default
conteúdo objecto Yes
└─ type OpenAI.EvalItemContentType No
função enumeração O papel da entrada da mensagem. Um de user, assistant, system, ou developer.
Valores possíveis: user, assistant, system, developer		 Yes
tipo enumeração O tipo de entrada da mensagem. Sempre message.
Valores possíveis: message		 No

OpenAI.EvalItemContent

Discriminador para OpenAI.EvalItemContent

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

Type Value Schema
input_text OpenAI.EvalItemContentInputText
output_text OpenAI.EvalItemContentOutputText
Name Tipo Description Required Default
tipo OpenAI.EvalItemContentType Yes

OpenAI.EvalItemContentInputText

Name Tipo Description Required Default
enviar SMS cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: input_text		 Yes

OpenAI.EvalItemContentOutputText

Name Tipo Description Required Default
enviar SMS cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: output_text		 Yes

OpenAI.EvalItemContentType

Property Value
Type cadeia (de caracteres)
Values input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

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

Name Tipo Description Required Default
origem objecto Yes
└─ content matriz O conteúdo do ficheiro jsonl. No
└─ id cadeia (de caracteres) O identificador do ficheiro. No
└─ type enumeração O tipo de fonte jsonl. Sempre file_id.
Valores possíveis: file_id		 No
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.

Name Tipo Description Required Default
dados matriz Uma variedade de objetos de avaliação. Yes
first_id cadeia (de caracteres) O identificador da primeira avaliação no array de dados. Yes
has_more boolean Indica se existem 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. Está sempre definido como "lista".
Valores possíveis: list		 Yes

OpenAI.EvalLogsDataSourceConfigParams

Uma configuração de fonte de dados que especifica a propriedade de metadados da tua consulta de logs. Isto costuma ser metadados como usecase=chatbot ou prompt-version=v2, etc.

Name Tipo Description Required Default
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
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 tua consulta de logs. Isto costuma ser metadados como usecase=chatbot ou prompt-version=v2, etc. O esquema devolvido por esta configuração de fonte de dados é usado para definir quais as variáveis disponíveis nas suas avaliações. item e sample são ambos definidos ao usar esta configuração de fonte de dados.

Name Tipo Description Required Default
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
esquema objecto O esquema json para os itens da fonte de dados executados.
Aprenda aqui a construir esquemas JSON.		 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.

Name Tipo Description Required Default
input_messages objecto No
└─ item_reference cadeia (de caracteres) Uma referência a uma variável no item namespace. Ie, "item.name" No
└─ template matriz Uma lista de mensagens de chat que formam o prompt ou contexto. Pode incluir referências de variáveis ao item namespace, ou seja, {{item.name}}. No
└─ type enumeração O tipo de mensagens de entrada. Sempre item_reference.
Valores possíveis: item_reference		 No
modelo cadeia (de caracteres) O nome do modelo a usar para gerar completões (por exemplo, "o3-mini"). No
sampling_params AzureEvalAPIResponseSamplingParams No
origem objecto Yes
└─ content matriz O conteúdo do ficheiro jsonl. No
└─ created_after número inteiro Inclua apenas itens criados após este carimbo temporal (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. No
└─ created_before número inteiro Inclua apenas itens criados antes deste carimbo temporal (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. No
└─ id cadeia (de caracteres) O identificador do ficheiro. No
└─ instructions_search cadeia (de caracteres) String opcional para pesquisar no campo 'instructions'. Este é um parâmetro de consulta usado para selecionar respostas. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ model cadeia (de caracteres) O nome do modelo para encontrar respostas. Este é um parâmetro de consulta usado para selecionar respostas. No
└─ reasoning_effort OpenAI.ReasoningEffort Parâmetro opcional de esforço de raciocínio. Este é um parâmetro de consulta usado para selecionar respostas. No
└─ temperature number Sampling temperature. Este é um parâmetro de consulta usado para selecionar respostas. No
└─ tools matriz Lista de nomes de ferramentas. Este é um parâmetro de consulta usado para selecionar respostas. No
└─ top_p number Parâmetro de amostragem do núcleo. Este é um parâmetro de consulta usado para selecionar respostas. No
└─ type enumeração O tipo de fonte de dados de execução. Sempre responses.
Valores possíveis: responses		 No
└─ users matriz Lista de identificadores de utilizador. Este é um parâmetro de consulta usado para selecionar respostas. No
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.

Name Tipo Description Required Default
created_at número inteiro Carimbo temporal do Unix (em segundos) quando a execução da avaliação foi criada. Yes
data_source objecto Yes
└─ type OpenAI.EvalRunDataSourceType No
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 único para a execução de 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ção adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
modelo cadeia (de caracteres) O modelo que é avaliado, se aplicável. Yes
name cadeia (de caracteres) O nome da corrida de avaliação. Yes
objecto enumeração O tipo do objeto. Always "eval.run".
Valores possíveis: eval.run		 Yes
per_model_usage matriz Estatísticas de utilização de cada modelo durante a execução da avaliação. Yes
per_testing_criteria_results matriz Resultados por critério de teste aplicado durante a execução da avaliação. Yes
report_url cadeia (de caracteres) O URL para o relatório de avaliação renderizado executa no painel da interface. Yes
result_counts objecto Os contadores que resumem os resultados da avaliação executam. Yes
└─ errored número inteiro Número de itens de saída que resultaram num erro. No
└─ failed número inteiro Número de itens de saída que não passaram na avaliação. No
└─ passed número inteiro Número de itens de saída que passaram na avaliação. No
└─ total número inteiro Número total de itens de saída executados. No
estado cadeia (de caracteres) O estado da análise de avaliação. Yes

OpenAI.EvalRunDataContentSource

Discriminador para OpenAI.EvalRunDataContentSource

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

Type Value Schema
file_id OpenAI.EvalRunFileIdDataContentSource
stored_completions OpenAI.EvalRunStoredCompletionsDataContentSource
responses OpenAI.EvalRunResponsesDataContentSource
Name Tipo Description Required Default
tipo OpenAI.EvalRunDataContentSourceType Yes

OpenAI.EvalRunDataContentSourceType

Property Value
Type cadeia (de caracteres)
Values file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: completions		 Yes

OpenAI.EvalRunDataSourceJsonlResource

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: jsonl		 Yes

OpenAI.EvalRunDataSourceParams

Discriminador para OpenAI.EvalRunDataSourceParams

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

Type Value Schema
jsonl OpenAI.EvalJsonlRunDataSourceParams
completions OpenAI.EvalCompletionsRunDataSourceParams
responses OpenAI.EvalResponsesRunDataSourceParams
Name Tipo Description Required Default
tipo OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResource

Name Tipo Description Required Default
tipo OpenAI.EvalRunDataSourceType Yes

OpenAI.EvalRunDataSourceResponsesResource

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: responses		 Yes

OpenAI.EvalRunDataSourceType

Property Value
Type cadeia (de caracteres)
Values jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

Name Tipo Description Required Default
conteúdo matriz O conteúdo do ficheiro jsonl. Yes
tipo enumeração O tipo de fonte jsonl. Sempre file_content.
Valores possíveis: file_content		 Yes

OpenAI.EvalRunFileIdDataContentSource

Name Tipo Description Required Default
id cadeia (de caracteres) O identificador do ficheiro. 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.

Name Tipo Description Required Default
dados matriz Uma variedade de objetos avaliados. Yes
first_id cadeia (de caracteres) O identificador da primeira avaliação executa no array de dados. Yes
has_more boolean Indica se existem mais avaliações disponíveis. Yes
last_id cadeia (de caracteres) O identificador da última corrida de avaliação no array de dados. Yes
objecto enumeração O tipo deste objeto. Está sempre definido como "lista".
Valores possíveis: list		 Yes

OpenAI.EvalRunOutputItem

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

Name Tipo Description Required Default
created_at número inteiro Carimbo temporal do Unix (em segundos) quando a execução da avaliação foi criada. Yes
datasource_item objecto Detalhes do item da fonte de dados de entrada. Yes
datasource_item_id número inteiro O identificador do item de origem dos 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 da execução da avaliação. Yes
objecto enumeração O tipo do objeto. Always "eval.run.output_item".
Valores possíveis: eval.run.output_item		 Yes
results matriz Uma lista de resultados da avaliação é executada. Yes
run_id cadeia (de caracteres) O identificador da execução de avaliação associado a este item de saída. Yes
amostra objecto Uma amostra contendo a entrada e saída da execução da avaliação. Yes
└─ error OpenAI.EvalApiError Um objeto que representa uma resposta de erro da API Eval. No
└─ finish_reason cadeia (de caracteres) A razão pela qual a geração de amostras foi concluída. No
└─ input matriz Uma série de mensagens de entrada. No
└─ max_completion_tokens número inteiro O número máximo de fichas permitido para completação. No
└─ model cadeia (de caracteres) O modelo utilizado para gerar a amostra. No
└─ output matriz Uma série de mensagens de saída. No
└─ seed número inteiro A semente usada para gerar a amostra. No
└─ temperature number A temperatura de amostragem utilizada. No
└─ top_p number O valor top_p usado para a amostragem. No
└─ usage objecto Detalhes de utilização do token para a amostra. No
└─ cached_tokens número inteiro O número de tokens recuperados do cache. No
└─ completion_tokens número inteiro O número de tokens de conclusão gerados. No
└─ prompt_tokens número inteiro O número de tokens de prompt usados. No
└─ total_tokens número inteiro O número total de fichas usadas. No
estado cadeia (de caracteres) O estado da análise de avaliação. Yes

OpenAI.EvalRunOutputItemList

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

Name Tipo Description Required Default
dados matriz Um array de objetos de saída de execução de avaliação. Yes
first_id cadeia (de caracteres) O identificador do primeiro item de saída da execução de avaliação no array de dados. Yes
has_more boolean Indica se existem mais itens de saída de avaliação disponíveis. Yes
last_id cadeia (de caracteres) O identificador do item de saída da última corrida de avaliação no array de dados. Yes
objecto enumeração O tipo deste objeto. Está 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.

Name Tipo Description Required Default
created_after número inteiro Inclua apenas itens criados após este carimbo temporal (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. No
created_before número inteiro Inclua apenas itens criados antes deste carimbo temporal (inclusive). Este é um parâmetro de consulta usado para selecionar respostas. No
instructions_search cadeia (de caracteres) String opcional para pesquisar no campo 'instructions'. Este é um parâmetro de consulta usado para selecionar respostas. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
modelo cadeia (de caracteres) O nome do modelo para encontrar respostas. Este é um parâmetro de consulta usado para selecionar respostas. No
reasoning_effort objecto Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
temperature number Sampling temperature. Este é um parâmetro de consulta usado para selecionar respostas. No
tools matriz Lista de nomes de ferramentas. Este é um parâmetro de consulta usado para selecionar respostas. No
top_p number Parâmetro de amostragem do núcleo. Este é um parâmetro de consulta usado para selecionar respostas. No
tipo enumeração O tipo de fonte de dados de execução. Sempre responses.
Valores possíveis: responses		 Yes
users matriz Lista de identificadores de utilizador. Este é um parâmetro de consulta usado para selecionar respostas. No

OpenAI.EvalRunStoredCompletionsDataContentSource

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

Name Tipo Description Required Default
created_after número inteiro Um carimbo temporal Unix opcional para filtrar itens criados após esse período. No
created_before número inteiro Um carimbo temporal Unix opcional para filtrar itens criados antes desse período. No
limit número inteiro Um número máximo opcional de itens para devolver. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
modelo cadeia (de caracteres) Um modelo opcional para filtrar (por exemplo, 'gpt-4o'). No
tipo enumeração O tipo de fonte. Sempre stored_completions.
Valores possíveis: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Descontinuado em favor do LogsDataSourceConfig.

Name Tipo Description Required Default
metadados objecto Filtros de metadados para a fonte de dados de completação armazenada. No
tipo enumeração O tipo de fonte de dados. Sempre stored_completions.
Valores possíveis: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Descontinuado em favor do LogsDataSourceConfig.

Name Tipo Description Required Default
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
esquema objecto O esquema json para os itens da fonte de dados executados.
Aprenda aqui a construir esquemas JSON.		 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údos relevantes a partir de ficheiros carregados.

Name Tipo Description Required Default
filters objecto No
max_num_results número inteiro O número máximo de resultados a devolver. Este número deve estar entre 1 e 50, inclusive. No
ranking_options objecto No
└─ ranker enumeração O ranker a usar para a pesquisa de ficheiros.
Valores possíveis: auto, default-2024-11-15		 No
└─ score_threshold number O limiar de pontuação para a pesquisa de ficheiros, um número entre 0 e 1. Números mais próximos de 1 tentarão devolver apenas os resultados mais relevantes, mas podem devolver menos resultados. No
tipo enumeração O tipo da ferramenta de pesquisa de ficheiros. Sempre file_search.
Valores possíveis: file_search		 Yes
vector_store_ids matriz Os IDs do vetor armazenam-se para pesquisar. Yes

OpenAI.FileSearchToolCallItemParam

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

Name Tipo Description Required Default
queries matriz As consultas usadas para procurar ficheiros. Yes
results matriz Os resultados da ferramenta de pesquisa de ficheiros chamam. No
tipo enumeração
Valores possíveis: file_search_call		 Yes

OpenAI.FileSearchToolCallItemResource

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

Name Tipo Description Required Default
queries matriz As consultas usadas para procurar ficheiros. Yes
results matriz Os resultados da ferramenta de pesquisa de ficheiros chamam. No
estado enumeração O estado da ferramenta de pesquisa de ficheiros chama. Um de in_progress, searching, incomplete ou failed.
Valores possíveis: in_progress, searching, completed, incomplete, failed		 Yes
tipo enumeração
Valores possíveis: file_search_call		 Yes

OpenAI.Filters

Name Tipo Description Required Default
filters matriz Conjunto de filtros para combinar. Os itens podem ser ComparisonFilter ou CompoundFilter. Yes
chave cadeia (de caracteres) A chave para comparar com o valor. Yes
tipo enumeração Tipo de operação: and ou or.
Valores possíveis: and, or		 Yes
value string ou número ou booleano O valor a comparar com a chave de atributos; suporta tipos de string, número ou booleanos. Yes

OpenAI.FineTuneDPOHyperparameters

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

Name Tipo Description Required Default
batch_size enumeração
Valores possíveis: auto		 No
beta enumeração
Valores possíveis: auto		 No
learning_rate_multiplier enumeração
Valores possíveis: auto		 No
n_epochs enumeração
Valores possíveis: auto		 No

OpenAI.FineTuneDPOMethod

Configuração para o método de afinação DPO.

Name Tipo Description Required Default
hyperparameters OpenAI.FineTuneDPOHyperparameters Os hiperparâmetros usados para o trabalho de ajuste fino do DPO. No

OpenAI.FineTuneMethod

O método usado para afinações.

Name Tipo Description Required Default
dpo OpenAI.FineTuneDPOMethod Configuração para o método de afinação DPO. No
reinforcement AzureFineTuneReinforcementMethod No
supervised OpenAI.FineTuneSupervisedMethod Configuração para o método supervisionado de ajuste fino. No
tipo enumeração O tipo de método. É ou supervised, dpo, ou reinforcement.
Valores possíveis: supervised, dpo, reinforcement		 Yes

OpenAI.FineTuneReinforcementHyperparameters

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

Name Tipo Description Required Default
batch_size enumeração
Valores possíveis: auto		 No
compute_multiplier enumeração
Valores possíveis: auto		 No
eval_interval enumeração
Valores possíveis: auto		 No
eval_samples enumeração
Valores possíveis: auto		 No
learning_rate_multiplier enumeração
Valores possíveis: auto		 No
n_epochs enumeração
Valores possíveis: auto		 No
reasoning_effort enumeração Nível de esforço de raciocínio.
Valores possíveis: default, low, medium, high		 No

OpenAI.FineTuneSupervisedHyperparameters

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

Name Tipo Description Required Default
batch_size enumeração
Valores possíveis: auto		 No
learning_rate_multiplier enumeração
Valores possíveis: auto		 No
n_epochs enumeração
Valores possíveis: auto		 No

OpenAI.FineTuneSupervisedMethod

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

Name Tipo Description Required Default
hyperparameters OpenAI.FineTuneSupervisedHyperparameters Os hiperparâmetros usados para o trabalho de ajuste fino. No

OpenAI.FineTuningIntegration

Discriminador para OpenAI.FineTuningIntegration

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

Type Value Schema
wandb OpenAI.FineTuningIntegrationWandb
Name Tipo Description Required Default
tipo string (ver modelos válidos abaixo) Yes

OpenAI.FineTuningIntegrationWandb

Name Tipo Description Required Default
tipo enumeração O tipo de integração a ser ativada para o trabalho de afinação.
Valores possíveis: wandb		 Yes
wandb objecto As definições para a tua integração com Pesos e Vieses. Esta carga útil especifica o projeto para o qual as métricas serão enviadas. Opcionalmente, podes definir um nome explícito para a tua run, adicionar tags à tua run e definir uma entidade padrão (equipa, nome de utilizador, etc.) para ser associada à tua run. Yes
└─ entity cadeia (de caracteres) A entidade a usar para a corrida. Isto permite-te definir a equipa ou nome de utilizador do utilizador WandB que gostarias de associar à run. Se não estiver definida, é usada a entidade padrão para a chave API WandB registada. No
└─ name cadeia (de caracteres) Um nome de exibição para definir para a corrida. Se não estiver definido, usaremos o ID do Trabalho como nome. No
└─ project cadeia (de caracteres) O nome do projeto sob o qual a nova corrida será criada. No
└─ tags matriz Uma lista de etiquetas a serem atribuídas à nova sequência criada. Estas etiquetas são passadas diretamente para a varinha B. Algumas etiquetas padrão são geradas pela OpenAI: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}". No

OpenAI.FineTuningJob

O fine_tuning.job objeto representa um trabalho de ajuste fino criado através da API.

Name Tipo Description Required Default
created_at número inteiro O carimbo temporal do Unix (em segundos) indica quando o trabalho de ajuste fino foi criado. Yes
erro objecto Para ajustes finos que tenham failed, isto conterá mais informação sobre a causa da falha. Yes
└─ code cadeia (de caracteres) Um código de erro legível por máquina. No
└─ message cadeia (de caracteres) Uma mensagem de erro legível por humanos. No
└─ param cadeia (de caracteres) O parâmetro que era inválido, normalmente training_file ou validation_file. Este campo será nulo se a falha não for específica de um parâmetro. No
estimated_finish número inteiro O carimbo temporal do Unix (em segundos) indica quando se estima que o trabalho de afinação está concluído. O valor será nulo se o trabalho de ajuste fino não estiver a correr. No
fine_tuned_model cadeia (de caracteres) O nome do modelo afinado que está a ser criado. O valor será nulo se o trabalho de ajuste fino ainda estiver a correr. Yes
finished_at número inteiro O carimbo temporal do Unix (em segundos) indicava quando o trabalho de afinação estava concluído. O valor será nulo se o trabalho de ajuste fino ainda estiver a correr. Yes
hyperparameters objecto Os hiperparâmetros usados para o trabalho de ajuste fino. Este valor só será devolvido ao executar supervised trabalhos. Yes
└─ batch_size enumeração
Valores possíveis: auto		 No
└─ learning_rate_multiplier enumeração
Valores possíveis: auto		 No
└─ n_epochs enumeração
Valores possíveis: auto		 No
id cadeia (de caracteres) O identificador de objeto, que pode ser referenciado nos endpoints da API. Yes
integrations matriz Uma lista de integrações para permitir este ajuste fino. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
método OpenAI.FineTuneMethod O método usado para afinações. No
modelo cadeia (de caracteres) O modelo base que está a ser afinado. 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 que detém o trabalho de afinação. Yes
result_files matriz O(s) ID(s) de ficheiro de resultados compilados para o trabalho de afinação. Pode obter os resultados com a API Files. Yes
seed número inteiro A semente usada para o trabalho de afinação. Yes
estado enumeração O estado atual do trabalho de afinação, que pode ser , validating_filesqueued, running, succeeded, failed, ou cancelled.
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 este trabalho de ajuste fino. O valor será nulo se o trabalho de ajuste fino ainda estiver a correr. Yes
training_file cadeia (de caracteres) O ID do ficheiro usado para treino. Podes recuperar os dados de treino com a API Files. Yes
user_provided_suffix cadeia (de caracteres) O sufixo descritivo aplicava-se ao cargo, conforme especificado no pedido de criação de emprego. No
validation_file cadeia (de caracteres) O ID do ficheiro usado para validação. Podes recuperar os resultados da validação com a API Files. Yes

OpenAI.FineTuningJobCheckpoint

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

Name Tipo Description Required Default
created_at número inteiro O carimbo temporal do Unix (em segundos) indica quando o checkpoint foi criado. Yes
fine_tuned_model_checkpoint cadeia (de caracteres) O nome do modelo de checkpoint finamente ajustado que é criado. Yes
fine_tuning_job_id cadeia (de caracteres) O nome do trabalho de ajuste fino a partir do qual este ponto de controlo foi criado. Yes
id cadeia (de caracteres) O identificador de checkpoint, que pode ser referenciado nos endpoints da API. Yes
métricas objecto Métricas no número do passo durante o ajuste fino. Yes
└─ full_valid_loss number No
└─ full_valid_mean_token_accuracy number No
└─ step number No
└─ train_loss number No
└─ train_mean_token_accuracy number No
└─ valid_loss number No
└─ valid_mean_token_accuracy number No
objecto enumeração O tipo de objeto, que é sempre "fine_tuning.job.checkpoint".
Valores possíveis: fine_tuning.job.checkpoint		 Yes
step_number número inteiro O número do passo onde o ponto de controlo foi criado. Yes

OpenAI.FineTuningJobEvent

Ajuste fino do objeto de evento do trabalho

Name Tipo Description Required Default
created_at número inteiro O carimbo temporal do Unix (em segundos) indica quando o trabalho de ajuste fino foi criado. Yes
dados Os dados associados ao evento. No
id cadeia (de caracteres) O identificador do objeto. Yes
nível enumeração O nível do registo 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		 No

OpenAI.FunctionObject

Name Tipo Description Required Default
description cadeia (de caracteres) Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função. No
name cadeia (de caracteres) O nome da função a ser chamada. Devem ser de a z, de A a Z, de 0 a 9, ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
parameters Os parâmetros que a função aceita, descritos como um objeto de Esquema JSON. No
strict boolean Se deve permitir a adesão estrita ao esquema ao gerar a chamada de função. Se definido como verdadeiro, o modelo seguirá exatamente o esquema definido no parameters campo. Apenas um subconjunto do esquema JSON é suportado quando strict é true. No False

OpenAI.FunctionTool

Define uma função no seu próprio código que o modelo pode escolher chamar.

Name Tipo Description Required Default
description cadeia (de caracteres) Uma descrição da função. Usado pelo modelo para determinar se deve ou não chamar a função. No
name cadeia (de caracteres) O nome da função a chamar. Yes
parameters Um objeto de esquema JSON que descreve os parâmetros da função. Yes
strict boolean Se deve impor uma validação rigorosa dos parâmetros. Padrão true. Yes
tipo enumeração O tipo da ferramenta funcional. Sempre function.
Valores possíveis: function		 Yes

OpenAI.FunctionToolCallItemParam

Uma chamada de ferramenta para executar uma função.

Name Tipo Description Required Default
arguments cadeia (de caracteres) Uma cadeia JSON dos argumentos para passar à função. Yes
call_id cadeia (de caracteres) O ID único da chamada de ferramenta de função gerada pelo modelo. Yes
name cadeia (de caracteres) O nome da função a executar. Yes
tipo enumeração
Valores possíveis: function_call		 Yes

OpenAI.FunctionToolCallItemResource

Uma chamada de ferramenta para executar uma função.

Name Tipo Description Required Default
arguments cadeia (de caracteres) Uma cadeia JSON dos argumentos para passar à função. Yes
call_id cadeia (de caracteres) O ID único da chamada de ferramenta de função gerada pelo modelo. Yes
name cadeia (de caracteres) O nome da função a executar. Yes
estado enumeração O estado do item. Um de in_progress, completed, ou incomplete. Preenche quando os itens são devolvidos 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 funcional.

Name Tipo Description Required Default
call_id cadeia (de caracteres) O ID único da chamada de ferramenta de função gerada pelo modelo. Yes
output cadeia (de caracteres) Uma string JSON da saída da chamada à 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 funcional.

Name Tipo Description Required Default
call_id cadeia (de caracteres) O ID único da chamada de ferramenta de função gerada pelo modelo. Yes
output cadeia (de caracteres) Uma string JSON da saída da chamada à ferramenta de função. Yes
estado enumeração O estado do item. Um de in_progress, completed, ou incomplete. Preenche quando os itens são devolvidos 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
label_model OpenAI.GraderLabelModel
text_similarity OpenAI.GraderTextSimilarity
python OpenAI.GraderPython
score_model OpenAI.GraderScoreModel
multi OpenAI.GraderMulti
Name Tipo Description Required Default
tipo OpenAI.GraderType Yes

OpenAI.GraderLabelModel

Um objeto LabelModelGrader que utiliza um modelo para atribuir etiquetas a cada item da avaliação.

Name Tipo Description Required Default
dados introduzidos matriz Yes
labels matriz Os rótulos a atribuir a cada item na avaliação. Yes
modelo cadeia (de caracteres) O modelo a usar para a avaliação. Deve suportar saídas estruturadas. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
passing_labels matriz As etiquetas que indicam um resultado de aprovação. 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 avaliadores para produzir uma única pontuação.

Name Tipo Description Required Default
calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. Yes
graders objecto Yes
name cadeia (de caracteres) O nome do avaliador. Yes
tipo enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 Yes

OpenAI.GraderPython

Um objeto PythonGrader que executa um script python na entrada.

Name Tipo Description Required Default
image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
name cadeia (de caracteres) O nome do avaliador. 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 utiliza um modelo para atribuir uma pontuação à entrada.

Name Tipo Description Required Default
dados introduzidos matriz O texto de entrada. Isto pode incluir cadeias de templates. Yes
modelo cadeia (de caracteres) O modelo a usar para a avaliação. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
intervalo matriz A amplitude da partitura. Por defeito, é [0, 1]. No
sampling_params Os parâmetros de amostragem para o modelo. No
tipo enumeração O tipo de objeto, que é sempre score_model.
Valores possíveis: score_model		 Yes

OpenAI.GraderStringCheck

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

Name Tipo Description Required Default
dados introduzidos cadeia (de caracteres) O texto de entrada. Isto pode incluir cadeias de templates. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
operação enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 Yes
referenciar cadeia (de caracteres) O texto de referência. Isto pode incluir cadeias de templates. Yes
tipo enumeração O tipo de objeto, que é sempre string_check.
Valores possíveis: string_check		 Yes

OpenAI.GraderTextSimilarity

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

Name Tipo Description Required Default
evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 Yes
dados introduzidos cadeia (de caracteres) O texto a ser avaliado. Yes
name cadeia (de caracteres) O nome do avaliador. Yes
referenciar cadeia (de caracteres) O texto a ser avaliado. Yes
tipo enumeração O tipo de avaliador.
Valores possíveis: text_similarity		 Yes

OpenAI.GraderType

Property Value
Type cadeia (de caracteres)
Values string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

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

Name Tipo Description Required Default
em segundo plano enumeração GPT-image-1 apenas: tipo de fundo para a imagem gerada. Um de transparent, opaque, ou auto. Padrão: auto.
Valores possíveis: transparent, opaque, auto		 No
input_image_mask objecto Máscara opcional para pintura. Contém image_url (string, opcional) e file_id (string, opcional). No
└─ file_id cadeia (de caracteres) ID do ficheiro para a imagem da máscara. No
└─ image_url cadeia (de caracteres) Imagem de máscara codificada em base64. No
modelo enumeração O modelo de geração de imagem a usar. Padrão: gpt-image-1.
Valores possíveis: gpt-image-1, gpt-image-1.5, gpt-image-2		 No
moderation enumeração Nível de moderação para a imagem gerada. Padrão: auto.
Valores possíveis: auto, low		 No
output_compression número inteiro Nível de compressão para a imagem de saída. Default: 100. No 100
output_format enumeração O formato de saída da imagem gerada. Um de png, webp, ou jpeg. Padrão: png.
Valores possíveis: png, webp, jpeg		 No
partial_images número inteiro Número de imagens parciais a gerar em modo de streaming, de 0 (valor padrão) a 3. No 0
quality enumeração A qualidade da imagem gerada. Um de low, medium, high, ou auto. Padrão: auto.
Valores possíveis: low, medium, high, auto		 No
size enumeração O tamanho da imagem gerada. Um de 1024x1024, 1024x1536, 1536x1024, ou auto. Padrão: auto.
Valores possíveis: 1024x1024, 1024x1536, 1536x1024, auto		 No
tipo enumeração O tipo da ferramenta de geração de imagens. Sempre image_generation.
Valores possíveis: image_generation		 Yes

OpenAI.ImageGenToolCallItemParam

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

Name Tipo Description Required Default
result cadeia (de caracteres) A imagem gerada foi 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.

Name Tipo Description Required Default
result cadeia (de caracteres) A imagem gerada foi 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

Name Tipo Description Required Default
conteúdo String ou array Yes

OpenAI.Includable

Especifique dados de saída adicionais para incluir 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 nos itens de chamada à ferramenta do interpretador de código.
  • computer_call_output.output.image_url: Incluir URLs de imagem da saída da chamada do computador.
  • file_search_call.results: Inclua os resultados de pesquisa da chamada da ferramenta de pesquisa de ficheiros.
  • message.input_image.image_url: Incluir URLs de imagem da mensagem de entrada.
  • message.output_text.logprobs: Incluir logprobs com mensagens de assistente.
  • reasoning.encrypted_content: Inclui uma versão encriptada dos tokens de raciocínio nas saídas dos itens de raciocínio. Isto permite que itens de raciocínio sejam usados em conversas com múltiplas curvas ao utilizar a API Respostas sem estado (como quando o store parâmetro está definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).
Property Value
Description Especifique dados de saída adicionais para incluir 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 nos itens de chamada à ferramenta do interpretador de código.
- computer_call_output.output.image_url: Incluir URLs de imagem da saída da chamada do computador.
- file_search_call.results: Inclua os resultados de pesquisa da chamada da ferramenta de pesquisa de ficheiros.
- message.input_image.image_url: Incluir URLs de imagem da mensagem de entrada.
- message.output_text.logprobs: Incluir logprobs com mensagens de assistente.
- reasoning.encrypted_content: Inclui uma versão encriptada dos tokens de raciocínio nas saídas dos itens de raciocínio. Isto permite que itens de raciocínio sejam usados em conversas com múltiplas curvas ao utilizar a API Respostas sem estado (como quando o store parâmetro está definido para false, ou quando uma organização está inscrita no programa de retenção de dados zero).
Type cadeia (de caracteres)
Values 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
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
Name Tipo Description Required Default
tipo OpenAI.ItemContentType Conteúdos de entrada e saída multimodais. Yes

OpenAI.ItemContentInputAudio

Uma entrada de áudio para o modelo.

Name Tipo Description Required Default
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 ficheiro para o modelo.

Name Tipo Description Required Default
file_data cadeia (de caracteres) O conteúdo do ficheiro a ser enviado para o modelo. No
file_id cadeia (de caracteres) O ID do ficheiro a ser enviado para o modelo. No
filename cadeia (de caracteres) O nome do ficheiro a ser enviado ao modelo. No
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.

Name Tipo Description Required Default
detail enumeração O nível de detalhe da imagem a enviar ao modelo. Um de high, low, ou auto. Por defeito, é auto.
Valores possíveis: low, high, auto		 No
file_id cadeia (de caracteres) O ID do ficheiro a ser enviado para o modelo. No
image_url cadeia (de caracteres) O URL da imagem a ser enviada para o modelo. Uma URL totalmente qualificada ou imagem codificada base64 numa URL de dados. No
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.

Name Tipo Description Required Default
enviar SMS cadeia (de caracteres) O texto introduzido no 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.

Name Tipo Description Required Default
dados cadeia (de caracteres) Dados de áudio codificados em Base64 do modelo. Yes
transcrição cadeia (de caracteres) A transcrição dos dados á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.

Name Tipo Description Required Default
annotations matriz As anotações da saída do texto. Yes
logprobs matriz No
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 da modelo.

Name Tipo Description Required Default
refusal 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 de entrada e saída multimodais.

Property Value
Description Conteúdos de entrada e saída multimodais.
Type cadeia (de caracteres)
Values 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
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
Name Tipo Description Required Default
tipo OpenAI.ItemType Yes

OpenAI.ItemReferenceItemParam

Um identificador interno para um item referenciar.

Name Tipo Description Required Default
id cadeia (de caracteres) O ID originado pelo serviço do item de resposta previamente gerado que está a ser 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
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
Name Tipo Description Required Default
id cadeia (de caracteres) Yes
tipo OpenAI.ItemType Yes

OpenAI.ItemType

Property Value
Type cadeia (de caracteres)
Values 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

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia (de caracteres) No
has_more boolean Yes
last_id cadeia (de caracteres) No
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListFineTuningJobEventsResponse

Name Tipo Description Required Default
dados matriz Yes
has_more boolean Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListModelsResponse

Name Tipo Description Required Default
dados matriz Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name Tipo Description Required Default
dados matriz Yes
has_more boolean Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListVectorStoreFilesFilter

Property Value
Type cadeia (de caracteres)
Values in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia (de caracteres) Yes
has_more boolean Yes
last_id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.ListVectorStoresResponse

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia (de caracteres) Yes
has_more boolean Yes
last_id cadeia (de caracteres) Yes
objecto enumeração
Valores possíveis: list		 Yes

OpenAI.LocalShellExecAction

Executa um comando shell no servidor.

Name Tipo Description Required Default
command matriz A ordem para fugir. Yes
env objecto Variáveis de ambiente a definir para o comando. Yes
timeout_ms número inteiro Tempo de espera opcional em milissegundos para o comando. No
tipo enumeração O tipo de ação local do projétil. Sempre exec.
Valores possíveis: exec		 Yes
utilizador cadeia (de caracteres) Utilizador opcional para executar o comando. No
working_directory cadeia (de caracteres) Diretório de trabalho opcional para executar o comando. No

OpenAI.LocalShellTool

Uma ferramenta que permite ao modelo executar comandos shell num ambiente local.

Name Tipo Description Required Default
tipo enumeração O tipo da ferramenta de concha local. Sempre local_shell.
Valores possíveis: local_shell		 Yes

OpenAI.LocalShellToolCallItemParam

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

Name Tipo Description Required Default
ação OpenAI.LocalShellExecAction Executa um comando shell no servidor. Yes
call_id cadeia (de caracteres) O ID único da chamada da ferramenta 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 na shell local.

Name Tipo Description Required Default
ação OpenAI.LocalShellExecAction Executa um comando shell no servidor. Yes
call_id cadeia (de caracteres) O ID único da chamada da ferramenta 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.

Name Tipo Description Required Default
output cadeia (de caracteres) Uma string JSON da saída da chamada local da ferramenta shell. Yes
tipo enumeração
Valores possíveis: local_shell_call_output		 Yes

OpenAI.LocalShellToolCallOutputItemResource

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

Name Tipo Description Required Default
output cadeia (de caracteres) Uma string JSON da saída da chamada local da ferramenta shell. Yes
estado enumeração
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração
Valores possíveis: local_shell_call_output		 Yes

OpenAI.Location

Discriminador para OpenAI.Localização

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

Type Value Schema
approximate OpenAI.ApproximateLocation
Name Tipo Description Required Default
tipo OpenAI.LocationType Yes

OpenAI.LocationType

Property Value
Type cadeia (de caracteres)
Values approximate

OpenAI.LogProb

A probabilidade logarítmica de um token.

Name Tipo Description Required Default
bytes matriz Yes
logprob number Yes
token cadeia (de caracteres) Yes
top_logprobs matriz Yes

OpenAI.MCPApprovalRequestItemParam

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

Name Tipo Description Required Default
arguments cadeia (de caracteres) Uma sequência de argumentos em JSON para a ferramenta. Yes
name cadeia (de caracteres) O nome da ferramenta a correr. Yes
server_label cadeia (de caracteres) O rótulo do servidor MCP que faz o pedido. Yes
tipo enumeração
Valores possíveis: mcp_approval_request		 Yes

OpenAI.MCPApprovalRequestItemResource

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

Name Tipo Description Required Default
arguments cadeia (de caracteres) Uma sequência de argumentos em JSON para a ferramenta. Yes
name cadeia (de caracteres) O nome da ferramenta a correr. Yes
server_label cadeia (de caracteres) O rótulo do servidor MCP que faz o pedido. Yes
tipo enumeração
Valores possíveis: mcp_approval_request		 Yes

OpenAI.MCPApprovalResponseItemParam

Uma resposta a um pedido de aprovação do MCP.

Name Tipo Description Required Default
approval_request_id cadeia (de caracteres) O ID do pedido de aprovação a ser respondido. Yes
approve boolean Se o pedido foi aprovado. Yes
reason cadeia (de caracteres) Motivo opcional para a decisão. No
tipo enumeração
Valores possíveis: mcp_approval_response		 Yes

OpenAI.MCPApprovalResponseItemResource

Uma resposta a um pedido de aprovação do MCP.

Name Tipo Description Required Default
approval_request_id cadeia (de caracteres) O ID do pedido de aprovação a ser respondido. Yes
approve boolean Se o pedido foi aprovado. Yes
reason cadeia (de caracteres) Motivo opcional para a decisão. No
tipo enumeração
Valores possíveis: mcp_approval_response		 Yes

OpenAI.MCPCallItemParam

Uma invocação de uma ferramenta num servidor MCP.

Name Tipo Description Required Default
arguments cadeia (de caracteres) Uma sequência JSON dos argumentos passada para a ferramenta. Yes
erro cadeia (de caracteres) O erro da chamada de ferramenta, se houver. No
name cadeia (de caracteres) O nome da ferramenta que foi executada. Yes
output cadeia (de caracteres) A saída da chamada de ferramenta. No
server_label 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 num servidor MCP.

Name Tipo Description Required Default
arguments cadeia (de caracteres) Uma sequência JSON dos argumentos passada para a ferramenta. Yes
erro cadeia (de caracteres) O erro da chamada de ferramenta, se houver. No
name cadeia (de caracteres) O nome da ferramenta que foi executada. Yes
output cadeia (de caracteres) A saída da chamada de ferramenta. No
server_label 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 num servidor MCP.

Name Tipo Description Required Default
erro cadeia (de caracteres) Mensagem de erro se o servidor não conseguir listar ferramentas. No
server_label cadeia (de caracteres) O rótulo do servidor MCP. Yes
tools 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 num servidor MCP.

Name Tipo Description Required Default
erro cadeia (de caracteres) Mensagem de erro se o servidor não conseguir listar ferramentas. No
server_label cadeia (de caracteres) O rótulo do servidor MCP. Yes
tools matriz As ferramentas disponíveis no servidor. Yes
tipo enumeração
Valores possíveis: mcp_list_tools		 Yes

OpenAI.MCPListToolsTool

Uma ferramenta disponível num servidor MCP.

Name Tipo Description Required Default
annotations Anotações adicionais sobre a ferramenta. No
description cadeia (de caracteres) A descrição da ferramenta. No
input_schema O esquema JSON que descreve a entrada da ferramenta. Yes
name cadeia (de caracteres) O nome da ferramenta. Yes

OpenAI.MCPTool

Dar ao modelo acesso a ferramentas adicionais através de servidores remotos do Model Context Protocol (MCP).

Name Tipo Description Required Default
allowed_tools objecto No
└─ tool_names matriz Lista de nomes de ferramentas permitidos. No
headers objecto Cabeçalhos HTTP opcionais para enviar ao servidor MCP. Uso para autenticação ou outros fins. No
require_approval objeto (ver modelos válidos abaixo) Especifique quais as ferramentas do servidor MCP que necessitam de aprovação. No
server_label cadeia (de caracteres) Um rótulo para este servidor MCP, usado para o identificar em chamadas de ferramenta. Yes
server_url cadeia (de caracteres) O 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. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.

Name Tipo Description Required Default
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No

OpenAI.Model

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

Name Tipo Description Required Default
created número inteiro O carimbo temporal do Unix (em segundos) quando o modelo foi criado. Yes
id cadeia (de caracteres) O identificador do modelo, que pode ser referenciado nos endpoints da API. Yes
objecto enumeração O tipo de objeto, que é sempre "model".
Valores possíveis: model		 Yes
owned_by cadeia (de caracteres) A organização que detém o modelo. Yes

OpenAI.OtherChunkingStrategyResponseParam

Isto é devolvido quando a estratégia de fragmentação é desconhecida. Normalmente, isto deve-se ao facto de o ficheiro ter sido indexado antes de o chunking_strategy conceito ser introduzido na API.

Name Tipo Description Required Default
tipo enumeração Sempre other.
Valores possíveis: other		 Yes

OpenAI.ParallelToolCalls

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

Type: boolean

OpenAI.Prompt

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

Name Tipo Description Required Default
id cadeia (de caracteres) O identificador único do modelo de prompt a usar. Yes
variables objecto Mapa opcional de valores para substituir variáveis no teu prompt. Os valores de substituição podem ser strings ou outros tipos de entrada de Resposta, como imagens ou ficheiros. No
versão cadeia (de caracteres) Versão opcional do modelo de prompt. No

OpenAI.RankingOptions

Name Tipo Description Required Default
classificador enumeração O ranker a usar para a pesquisa de ficheiros.
Valores possíveis: auto, default-2024-11-15		 No
score_threshold number O limiar de pontuação para a pesquisa de ficheiros, um número entre 0 e 1. Números mais próximos de 1 tentarão devolver apenas os resultados mais relevantes, mas podem devolver menos resultados. No

OpenAI.Reasoning

Apenas modelos da série O

Name Tipo Description Required Default
effort objecto Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
generate_summary enumeração Obsoleto: usa 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No

OpenAI.ReasoningEffort

Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio. Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.

Property Value
Description Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.
Type cadeia (de caracteres)
Values 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 estes itens na input sua API de Respostas para os turnos seguintes de uma conversa se estiver a gerir o contexto manualmente.

Name Tipo Description Required Default
encrypted_content cadeia (de caracteres) O conteúdo encriptado do item de raciocínio - preenchido quando uma resposta é gerada com reasoning.encrypted_content no include parâmetro. No
resumo matriz Raciocínio 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 estes itens na input sua API de Respostas para os turnos seguintes de uma conversa se estiver a gerir o contexto manualmente.

Name Tipo Description Required Default
encrypted_content cadeia (de caracteres) O conteúdo encriptado do item de raciocínio - preenchido quando uma resposta é gerada com reasoning.encrypted_content no include parâmetro. No
resumo matriz Raciocínio do conteúdo do texto. Yes
tipo enumeração
Valores possíveis: reasoning		 Yes

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Type Value Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
Name Tipo Description Required Default
tipo OpenAI.ReasoningItemSummaryPartType Yes

OpenAI.ReasoningItemSummaryPartType

Property Value
Type cadeia (de caracteres)
Values summary_text

OpenAI.ReasoningItemSummaryTextPart

Name Tipo Description Required Default
enviar SMS cadeia (de caracteres) Yes
tipo enumeração
Valores possíveis: summary_text		 Yes

OpenAI.Response

Name Tipo Description Required Default
em segundo plano boolean Se deve executar a resposta do modelo em segundo plano. No False
created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. Yes
erro objecto Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. Yes
└─ code OpenAI.ResponseErrorCode O código de erro da resposta. No
└─ message cadeia (de caracteres) Uma descrição legível para humanos do erro. No
id cadeia (de caracteres) Identificador único para esta Resposta. Yes
incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. Yes
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
instructions String ou array 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 No
max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
objecto enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 Yes
output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 Yes
output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. Yes True
previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
avisar objecto Referência a um modelo de prompt e às suas variáveis. No
└─ id cadeia (de caracteres) O identificador único do modelo de prompt a usar. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores para substituir variáveis no teu prompt. Os valores de substituição podem ser strings ou outros tipos de entrada de Resposta, como imagens ou ficheiros. No
└─ version cadeia (de caracteres) Versão opcional do modelo de prompt. No
reasoning objecto Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ effort OpenAI.ReasoningEffort Apenas modelos da série O

Limita o esforço de raciocínio para modelos de raciocínio.
Os valores atualmente suportados são low, medium, e high. Reduzir o esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio numa resposta.		 No
└─ generate_summary enumeração Obsoleto: usa 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
└─ summary 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, concise, ou detailed.
Valores possíveis: auto, concise, detailed		 No
estado enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto 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 texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objecto Controla qual (se houver) ferramenta chamada pelo modelo.

none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo tem de chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta incorporada para gerar uma resposta. No
tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 Yes
truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
utilização OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
utilizador cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Name Tipo Description Required Default
delta cadeia (de caracteres) O excerto parcial de código está a ser transmitido pelo interpretador de código. Yes
item_id cadeia (de caracteres) O identificador único da ferramenta de interpretação de código chama o item. Yes
output_index número inteiro O índice do item de saída na resposta para a qual o código está a ser 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 fragmento de código é finalizado pelo interpretador de código.

Name Tipo Description Required Default
código cadeia (de caracteres) O excerto final de código produzido pelo interpretador de código. Yes
item_id cadeia (de caracteres) O identificador único da ferramenta de interpretação de código chama o item. Yes
output_index número inteiro O índice do item de saída na resposta para a qual o código está 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 ao interpretador de código é concluída.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único da ferramenta de interpretação de código chama o item. 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 curso.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único da ferramenta de interpretação de código chama o item. Yes
output_index número inteiro O índice do item de saída na resposta para a qual o interpretador de código chamado está em curso. 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á a interpretar ativamente o fragmento de código.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único da ferramenta de interpretação de código chama o item. Yes
output_index número inteiro O índice do item de saída na resposta para a qual o interpretador de código está a interpretar 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á concluída.

Name Tipo Description Required Default
response objecto Yes
└─ background boolean Se deve executar a resposta do modelo em segundo plano. No False
└─ created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. No
└─ id cadeia (de caracteres) Identificador único para esta Resposta. No
└─ incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. No
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions String ou array Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
└─ 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 No
└─ max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 No
└─ output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 No
└─ output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e às suas variáveis. No
└─ reasoning OpenAI.Reasoning Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No
└─ text objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve escolher qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar que ferramentas o modelo pode chamar. No
└─ tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
└─ top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
└─ user cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No
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.

Name Tipo Description Required Default
content_index número inteiro O índice da parte de conteúdo que foi adicionada. Yes
item_id cadeia (de caracteres) O 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
part objecto Yes
└─ type OpenAI.ItemContentType Conteúdos de entrada e saída multimodais. No
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 de conteúdo é concluída.

Name Tipo Description Required Default
content_index número inteiro O índice da parte do conteúdo que é feita. Yes
item_id cadeia (de caracteres) O 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
part objecto Yes
└─ type OpenAI.ItemContentType Conteúdos de entrada e saída multimodais. No
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.

Name Tipo Description Required Default
response objecto Yes
└─ background boolean Se deve executar a resposta do modelo em segundo plano. No False
└─ created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. No
└─ id cadeia (de caracteres) Identificador único para esta Resposta. No
└─ incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. No
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions String ou array Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
└─ 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 No
└─ max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 No
└─ output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 No
└─ output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e às suas variáveis. No
└─ reasoning OpenAI.Reasoning Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O estado 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		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No
└─ text objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve escolher qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar que ferramentas o modelo pode chamar. No
└─ tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
└─ top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
└─ user cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No
tipo enumeração O tipo de evento. Sempre response.created.
Valores possíveis: response.created		 Yes

OpenAI.ResponseError

Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta.

Name Tipo Description Required Default
código OpenAI.ResponseErrorCode O código de erro da resposta. Yes
mensagem cadeia (de caracteres) Uma descrição legível para humanos do erro. Yes

OpenAI.ResponseErrorCode

O código de erro da resposta.

Property Value
Description O código de erro da resposta.
Type cadeia (de caracteres)
Values 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.

Name Tipo Description Required Default
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 de erro. 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.

Name Tipo Description Required Default
response objecto Yes
└─ background boolean Se deve executar a resposta do modelo em segundo plano. No False
└─ created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. No
└─ id cadeia (de caracteres) Identificador único para esta Resposta. No
└─ incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. No
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions String ou array Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
└─ 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 No
└─ max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 No
└─ output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 No
└─ output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e às suas variáveis. No
└─ reasoning OpenAI.Reasoning Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No
└─ text objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve escolher qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar que ferramentas o modelo pode chamar. No
└─ tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que estendem as capacidades do modelo.		 No
└─ top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
└─ user cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No
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 ficheiro é concluída (resultados encontrados).

Name Tipo Description Required Default
item_id cadeia (de caracteres) O ID do item de saída que a pesquisa de ficheiro é iniciado. Yes
output_index número inteiro O índice do item de saída que a pesquisa de ficheiro é iniciado. 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 ficheiro é iniciada.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O ID do item de saída que a pesquisa de ficheiro é iniciado. Yes
output_index número inteiro O índice do item de saída que a pesquisa de ficheiro é iniciado. 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 ficheiros está atualmente a ser pesquisada.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O ID do item de saída que a pesquisa de ficheiro é iniciado. Yes
output_index número inteiro O índice do item de saída que a pesquisa de ficheiro chama está a pesquisar. 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
text OpenAI.ResponseFormatText
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
Name Tipo Description Required Default
tipo enumeração
Valores possíveis: text, json_object, json_schema		 Yes

OpenAI.ResponseFormatJsonObject

Formato de resposta a objetos JSON. Um método mais antigo de gerar respostas JSON. O uso json_schema é recomendado para modelos que o suportem. Note que o modelo não gera JSON sem uma mensagem do sistema ou do utilizador a instruí-lo a fazê-lo.

Name Tipo Description Required Default
tipo enumeração O tipo de formato de resposta que está a ser definido. Sempre json_object.
Valores possíveis: json_object		 Yes

OpenAI.ResponseFormatJsonSchema

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

Name Tipo Description Required Default
json_schema objecto Opções de configuração do Structured Outputs, incluindo um Esquema JSON. Yes
└─ description cadeia (de caracteres) Uma descrição do que serve o formato de resposta, usada pelo modelo para determinar como responder nesse formato. No
└─ name cadeia (de caracteres) O nome do formato da resposta. Devem ser de a z, de A a Z, de 0 a 9, ou conter sublinhados e traços, com um comprimento máximo de 64. No
└─ schema OpenAI.ResponseFormatJsonSchemaSchema O esquema para o formato de resposta, descrito como um objeto de Esquema JSON.
Aprenda aqui a construir esquemas JSON.		 No
└─ strict boolean Se deve ativar a adesão estrita ao esquema ao gerar a saída.
Se definido como verdadeiro, o modelo seguirá sempre o esquema exato definido no schema campo. Apenas um subconjunto do esquema JSON é suportado quando strict é true.		 No False
tipo enumeração O tipo de formato de resposta que está a ser 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. Aprenda aqui a construir esquemas JSON.

Type: object

OpenAI.ResponseFormatText

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

Name Tipo Description Required Default
tipo enumeração O tipo de formato de resposta que está a ser definido. Sempre text.
Valores possíveis: text		 Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Emitido quando existe um delta parcial de argumentos de chamada de função.

Name Tipo Description Required Default
delta cadeia (de caracteres) Os argumentos de chamada de função delta que são adicionados. Yes
item_id cadeia (de caracteres) O ID do item de saída ao qual o delta dos argumentos da chamada de função é adicionado. Yes
output_index número inteiro O índice do item de saída ao qual o delta dos argumentos da chamada de função é somado. 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.

Name Tipo Description Required Default
arguments cadeia (de caracteres) Os argumentos da chamada de funções. Yes
item_id cadeia (de caracteres) A identificação 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 termina e a imagem final está disponível.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único do item de geração de imagem que está a ser processado. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always '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á ativamente a gerar uma imagem (estado intermédio).

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único do item de geração de imagem que está a ser processado. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always 'response.image_generation_call.generating'.
Valores possíveis: response.image_generation_call.generating		 Yes

OpenAI.ResponseImageGenCallInProgressEvent

Emitido quando uma chamada de ferramenta de geração de imagem está em curso.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único do item de geração de imagem que está a ser processado. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always 'response.image_generation_call.in_progress'.
Valores possíveis: response.image_generation_call.in_progress		 Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Emitido quando uma imagem parcial está disponível durante o streaming de geração de imagens.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único do item de geração de imagem que está a ser processado. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
partial_image_b64 cadeia (de caracteres) Dados parciais de imagem codificados em base64, adequados para renderização como imagem. Yes
partial_image_index número inteiro Índice baseado em 0 para a imagem parcial (o backend é baseado em 1, mas este é baseado em 0 para o utilizador). Yes
tipo enumeração O tipo de evento. Always '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.

Name Tipo Description Required Default
response objecto Yes
└─ background boolean Se deve executar a resposta do modelo em segundo plano. No False
└─ created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. No
└─ id cadeia (de caracteres) Identificador único para esta Resposta. No
└─ incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. No
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions String ou array Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
└─ 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 No
└─ max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 No
└─ output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 No
└─ output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e às suas variáveis. No
└─ reasoning OpenAI.Reasoning Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No
└─ text objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve escolher qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar que ferramentas o modelo pode chamar. No
└─ tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
└─ top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
└─ user cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No
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.

Name Tipo Description Required Default
response objecto Yes
└─ background boolean Se deve executar a resposta do modelo em segundo plano. No False
└─ created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. No
└─ id cadeia (de caracteres) Identificador único para esta Resposta. No
└─ incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. No
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions String ou array Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
└─ 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 No
└─ max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 No
└─ output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 No
└─ output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e às suas variáveis. No
└─ reasoning OpenAI.Reasoning Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No
└─ text objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve escolher qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar que ferramentas o modelo pode chamar. No
└─ tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
└─ top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
└─ user cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No
tipo enumeração O tipo de evento. Sempre response.incomplete.
Valores possíveis: response.incomplete		 Yes

OpenAI.ResponseItemList

Uma lista de itens de Resposta.

Name Tipo Description Required Default
dados matriz Uma lista dos itens usados para gerar esta resposta. Yes
first_id cadeia (de caracteres) O ID do primeiro item da lista. Yes
has_more boolean Se há mais artigos disponíveis. Yes
last_id cadeia (de caracteres) O ID do último item da lista. Yes
objecto enumeração O tipo de objeto devolvido deve ser list.
Valores possíveis: list		 Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Emitido quando existe um delta (atualização parcial) nos argumentos de uma chamada de ferramenta MCP.

Name Tipo Description Required Default
delta A atualização parcial dos argumentos para a chamada à ferramenta MCP. Yes
item_id cadeia (de caracteres) O identificador único da ferramenta MCP chama o item em processamento. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always '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.

Name Tipo Description Required Default
arguments Os argumentos finais para a chamada à ferramenta MCP. Yes
item_id cadeia (de caracteres) O identificador único da ferramenta MCP chama o item em processamento. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always 'response.mcp_call.arguments_done'.
Valores possíveis: response.mcp_call.arguments_done		 Yes

OpenAI.ResponseMCPCallCompletedEvent

Emitido quando uma chamada de ferramenta MCP é concluída com sucesso.

Name Tipo Description Required Default
tipo enumeração O tipo de evento. Always 'response.mcp_call.completed'.
Valores possíveis: response.mcp_call.completed		 Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falhou.

Name Tipo Description Required Default
tipo enumeração O tipo de evento. Always 'response.mcp_call.failed'.
Valores possíveis: response.mcp_call.failed		 Yes

OpenAI.ResponseMCPCallInProgressEvent

Emitido quando uma chamada de ferramenta MCP está em curso.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único da ferramenta MCP chama o item em processamento. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always 'response.mcp_call.in_progress'.
Valores possíveis: response.mcp_call.in_progress		 Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Emitido quando a lista de ferramentas MCP disponíveis foi recuperada com sucesso.

Name Tipo Description Required Default
tipo enumeração O tipo de evento. Always '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.

Name Tipo Description Required Default
tipo enumeração O tipo de evento. Always 'response.mcp_list_tools.failed'.
Valores possíveis: response.mcp_list_tools.failed		 Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Emitido quando o sistema está a recuperar a lista de ferramentas MCP disponíveis.

Name Tipo Description Required Default
tipo enumeração O tipo de evento. Always '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.

Name Tipo Description Required Default
item objecto Item de conteúdo usado para gerar uma resposta. Yes
└─ id cadeia (de caracteres) No
└─ type OpenAI.ItemType No
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.

Name Tipo Description Required Default
item objecto Item de conteúdo usado para gerar uma resposta. Yes
└─ id cadeia (de caracteres) No
└─ type OpenAI.ItemType No
output_index número inteiro O índice do item de saída que foi marcado como feito. 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 no teu prompt. Os valores de substituição podem ser strings ou outros tipos de entrada de Resposta, como imagens ou ficheiros.

Type: object

OpenAI.ResponseQueuedEvent

Emitido quando uma resposta está em fila e à espera de ser processada.

Name Tipo Description Required Default
response objecto Yes
└─ background boolean Se deve executar a resposta do modelo em segundo plano. No False
└─ created_at número inteiro Carimbo temporal do Unix (em segundos) de quando esta resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro devolvido quando o modelo falha em gerar uma Resposta. No
└─ id cadeia (de caracteres) Identificador único para esta Resposta. No
└─ incomplete_details objecto Detalhes sobre porque é que a resposta está incompleta. No
└─ reason enumeração A razão pela qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions String ou array Uma mensagem do sistema (ou do desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão transferidas para a resposta seguinte. Isto facilita a troca de mensagens do sistema (ou do programador) em novas respostas.		 No
└─ 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 No
└─ max_tool_calls número inteiro O número máximo de chamadas totais para ferramentas incorporadas que podem ser processadas numa resposta. Este número máximo aplica-se a todas as chamadas de ferramenta incorporadas, não a cada ferramenta individual. Qualquer tentativa adicional de chamar uma ferramenta pelo modelo será ignorada. No
└─ metadata objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto deste recurso - sempre definido para response.
Valores possíveis: response		 No
└─ output matriz Uma variedade de conteúdos gerados pelo modelo.

- O comprimento e a ordem dos itens no output array dependem da resposta do modelo.
- Em vez de aceder ao primeiro item do output array e assumir que é uma assistant mensagem com o conteúdo gerado pelo modelo, pode considerar usar a output_text propriedade onde suportada nos SDKs.		 No
└─ output_text cadeia (de caracteres) Propriedade de conveniência apenas SDK que contém o texto agregado de saída de todos os output_text itens do output array, se houver algum.
Suportado nos SDKs de Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia (de caracteres) O ID único da resposta anterior ao modelo. Usa isto para criar conversas com vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e às suas variáveis. No
└─ reasoning OpenAI.Reasoning Apenas modelos da série O

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O estado da geração de resposta. Um de completed, failed, in_progress, cancelled, queued, ou incomplete.
Valores possíveis: completed, failed, in_progress, cancelled, queued, incomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos como 0,8 tornam a saída mais aleatória, enquanto valores mais baixos como 0,2 tornam-na mais focada e determinística.
Geralmente recomendamos alterar isto ou top_p , mas não ambos.		 No
└─ text objecto Opções de configuração para uma resposta de texto do modelo. Pode ser texto simples ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve escolher qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar que ferramentas o modelo pode chamar. No
└─ tools matriz Um conjunto de ferramentas que o modelo pode invocar enquanto gera uma resposta. Podes especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas integradas: Ferramentas fornecidas pela OpenAI que expandem as capacidades do modelo.		 No
└─ top_logprobs número inteiro Um número inteiro entre 0 e 20 que especifica o número de tokens mais prováveis a serem retornados em cada posição do token, cada um com uma probabilidade logarítmica associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, onde o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0,1 significa que apenas os tokens que compõem o top 10% massa de probabilidade são considerados.

Geralmente recomendamos alterar isto ou temperature , mas não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a usar 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á a resposta para se ajustar à janela de contexto, eliminando itens de entrada a meio da conversa.
- disabled (padrão): Se uma resposta de modelo exceder o tamanho da janela de contexto para um modelo, o pedido falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados. No
└─ user cadeia (de caracteres) Um identificador único que representa o seu utilizador final, que pode ajudar a OpenAI a monitorizar e detetar abusos. No
tipo enumeração O tipo de evento. Always 'response.queued'.
Valores possíveis: response.queued		 Yes

OpenAI.ResponseReasoningDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo do raciocínio.

Name Tipo Description Required Default
content_index número inteiro O índice da parte do conteúdo de raciocínio dentro do item de saída. Yes
delta A atualização parcial do conteúdo de raciocínio. Yes
item_id cadeia (de caracteres) O identificador único do item para o qual o raciocínio está a ser atualizado. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
tipo enumeração O tipo de evento. Always 'response.reasoning.delta'.
Valores possíveis: response.reasoning.delta		 Yes

OpenAI.ResponseReasoningDoneEvent

Emitido quando o conteúdo de raciocínio é finalizado para um item.

Name Tipo Description Required Default
content_index número inteiro O índice da parte do conteúdo de raciocínio dentro do item de saída. Yes
item_id cadeia (de caracteres) O identificador único do item para o qual o raciocínio é finalizado. Yes
output_index número inteiro O índice do item de saída no array de saída da resposta. Yes
enviar SMS cadeia (de caracteres) O texto final de raciocínio. Yes
tipo enumeração O tipo de evento. Always 'response.reasoning.done'.
Valores possíveis: response.reasoning.done		 Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Emitido quando existe uma diferença (atualização parcial) no conteúdo do resumo do raciocínio.

Name Tipo Description Required Default
delta A atualização parcial do conteúdo do resumo do raciocínio. Yes
item_id cadeia (de caracteres) O identificador único do item para o qual o resumo de raciocínio está a ser atualizado. Yes
output_index número inteiro O índice do item de saída no array 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. Always 'response.reasoning_summary.delta'.
Valores possíveis: response.reasoning_summary.delta		 Yes

OpenAI.ResponseReasoningSummaryDoneEvent

Emitido quando o conteúdo do resumo do raciocínio é finalizado para um item.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O identificador único do item para o qual o resumo de raciocínio foi finalizado. Yes
output_index número inteiro O índice do item de saída no array 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 resumo final do raciocínio. Yes
tipo enumeração O tipo de evento. Always 'response.reasoning_summary.done'.
Valores possíveis: response.reasoning_summary.done		 Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

Name Tipo Description Required Default
item_id cadeia (de caracteres) O ID do item a que esta parte de resumo está associada. Yes
output_index número inteiro O índice do item de saída a que esta parte de resumo está associada. Yes
part objecto Yes
└─ type OpenAI.ReasoningItemSummaryPartType No
summary_index número inteiro O índice da parte do resumo dentro do resumo de raciocínio. Yes
tipo enumeração O tipo de evento. Sempre response.reasoning_summary_part.added.
Valores possíveis: response.reasoning_summary_part.added		 Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte resumida de raciocínio é concluída.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O ID do item a que esta parte de resumo está associada. Yes
output_index número inteiro O índice do item de saída a que esta parte de resumo está associada. Yes
part objecto Yes
└─ type OpenAI.ReasoningItemSummaryPartType No
summary_index número inteiro O índice da parte do resumo dentro do resumo de raciocínio. Yes
tipo enumeração O tipo de evento. Sempre response.reasoning_summary_part.done.
Valores possíveis: response.reasoning_summary_part.done		 Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitido quando um delta é adicionado a um texto resumido de raciocínio.

Name Tipo Description Required Default
delta cadeia (de caracteres) O texto delta que foi adicionado ao resumo. Yes
item_id cadeia (de caracteres) O ID do item ao qual este texto resumo delta está associado. Yes
output_index número inteiro O índice do item de saída ao qual este delta de texto resumo está associado. Yes
summary_index número inteiro O índice da parte do resumo dentro do resumo de raciocínio. Yes
tipo enumeração O tipo de evento. Sempre response.reasoning_summary_text.delta.
Valores possíveis: response.reasoning_summary_text.delta		 Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitido quando um texto resumido de raciocínio é concluído.

Name Tipo Description Required Default
item_id cadeia (de caracteres) O ID do item a que este texto 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 do resumo dentro do resumo de raciocínio. Yes
enviar SMS cadeia (de caracteres) O texto completo do resumo do raciocínio completo. 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.

Name Tipo Description Required Default
content_index número inteiro O índice da parte de conteúdo a que o texto de recusa é adicionado. Yes
delta cadeia (de caracteres) O texto de recusa que é adicionado. Yes
item_id cadeia (de caracteres) O ID do item de saída ao qual o texto de recusa é adicionado. 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.

Name Tipo Description Required Default
content_index número inteiro O índice do conteúdo da parte onde o texto da recusa está finalizado. Yes
item_id cadeia (de caracteres) O ID do item de saída onde o texto de recusa está finalizado. Yes
output_index número inteiro O índice do item de saída onde o texto de recusa está finalizado. Yes
refusal cadeia (de caracteres) O texto de recusa 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 utiliza a propriedade type para discriminar entre diferentes tipos:

Type Value Schema
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
Name Tipo Description Required Default
sequence_number número inteiro O número de sequência deste evento. Yes
tipo OpenAI.ResponseStreamEventType Yes

OpenAI.ResponseStreamEventType

Property Value
Type cadeia (de caracteres)
Values 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 adicional de texto.

Name Tipo Description Required Default
content_index número inteiro O índice da parte de conteúdo a que foi adicionado o delta de texto. Yes
delta cadeia (de caracteres) A diferença de texto que foi adicionada. Yes
item_id cadeia (de caracteres) O ID do item de saída ao qual a delta de texto foi adicionada. Yes
output_index número inteiro O índice do item de saída ao qual a delta de texto foi adicionada. 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 de texto é finalizado.

Name Tipo Description Required Default
content_index número inteiro O índice do conteúdo, parte onde o conteúdo do texto está finalizado. Yes
item_id cadeia (de caracteres) O ID do item de saída onde o conteúdo do texto está finalizado. Yes
output_index número inteiro O índice do item de saída onde o conteúdo do texto está 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

OpenAI.ResponseTextFormatConfiguration

Discriminador para OpenAI.ResponseTextFormatConfiguration

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

Type Value Schema
text OpenAI.ResponseTextFormatConfigurationText
json_object OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
Name Tipo Description Required Default
tipo OpenAI.ResponseTextFormatConfigurationType Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } ativa as Saídas Estruturadas, que garantem que o modelo corresponde ao seu esquema JSON fornecido. 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" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo é JSON válida. O uso json_schema é preferido para modelos que o suportam.		 Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: json_object		 Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

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

Name Tipo Description Required Default
description cadeia (de caracteres) Uma descrição do que serve o formato de resposta, usada pelo modelo para determinar como responder nesse formato. No
name cadeia (de caracteres) O nome do formato da resposta. Devem ser de a z, de A a Z, de 0 a 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.
Aprenda aqui a construir esquemas JSON.		 Yes
strict boolean Se deve ativar a adesão estrita ao esquema ao gerar a saída.
Se definido como verdadeiro, o modelo seguirá sempre o esquema exato definido no schema campo. Apenas um subconjunto do esquema JSON é suportado quando strict é true.		 No False
tipo enumeração O tipo de formato de resposta que está a ser definido. Sempre json_schema.
Valores possíveis: json_schema		 Yes

OpenAI.ResponseTextFormatConfigurationText

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: text		 Yes

OpenAI.ResponseTextFormatConfigurationType

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

A configuração { "type": "json_schema" } ativa as Saídas Estruturadas, que garantem que o modelo corresponde ao seu esquema JSON fornecido.

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" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo é JSON válida. O uso json_schema é preferido para modelos que o suportam.

Property Value
Description Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } ativa as Saídas Estruturadas, que garantem que o modelo corresponde ao seu esquema JSON fornecido.

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" } ativar o modo JSON mais antigo, que garante que a mensagem gerada pelo modelo é JSON válida. O uso json_schemaé preferido para modelos que o suportam.

OpenAI.ResponseUsage

Representa detalhes de utilização dos tokens, incluindo tokens de entrada, tokens de saída, uma divisão dos tokens de saída e o total de tokens utilizados.

Name Tipo Description Required Default
input_tokens número inteiro O número de tokens de entrada. Yes
input_tokens_details objecto Uma análise detalhada dos tokens de entrada. Yes
└─ cached_tokens número inteiro O número de tokens que foram recuperados do cache. No
output_tokens número inteiro O número de tokens de saída. Yes
output_tokens_details objecto Uma análise detalhada dos tokens de saída. Yes
└─ reasoning_tokens número inteiro O número de fichas de raciocínio. No
total_tokens número inteiro O número total de fichas usadas. Yes

OpenAI.ResponseWebSearchCallCompletedEvent

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

Name Tipo Description Required Default
item_id cadeia (de caracteres) ID único para o item de saída associado à chamada de pesquisa web. Yes
output_index número inteiro O índice do item de saída ao qual a chamada de pesquisa 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

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

Name Tipo Description Required Default
item_id cadeia (de caracteres) ID único para o item de saída associado à chamada de pesquisa web. Yes
output_index número inteiro O índice do item de saída ao qual a chamada de pesquisa 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

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

Name Tipo Description Required Default
item_id cadeia (de caracteres) ID único para o item de saída associado à chamada de pesquisa web. Yes
output_index número inteiro O índice do item de saída ao qual a chamada de pesquisa 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 o assistant papel.

Name Tipo Description Required Default
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.

Name Tipo Description Required Default
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 o developer papel.

Name Tipo Description Required Default
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.

Name Tipo Description Required Default
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 da mensagem de resposta, representando um papel e conteúdo, conforme fornecido como parâmetros de pedido do cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

Este componente utiliza a propriedade role para discriminar entre diferentes tipos:

Type Value Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
Name Tipo Description Required Default
função objecto A coleção de papéis válidos para os itens de mensagens de resposta. Yes
tipo enumeração O tipo do item de resposta, que é sempre 'mensagem'.
Valores possíveis: message		 Yes

OpenAI.ResponsesMessageItemResource

Um item de recurso da mensagem de resposta, representando um papel e conteúdo, conforme fornecido nas respostas de serviço.

Discriminador para OpenAI.RespostasMensagemItemResource

Este componente utiliza a propriedade role para discriminar entre diferentes tipos:

Type Value Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
Name Tipo Description Required Default
função objecto A coleção de papéis válidos para os itens de mensagens de resposta. Yes
estado enumeração O estado do item. Um de in_progress, completed, ou incomplete. Preenche quando os itens são devolvidos via API.
Valores possíveis: in_progress, completed, incomplete		 Yes
tipo enumeração O tipo do item de resposta, que é sempre 'mensagem'.
Valores possíveis: message		 Yes

OpenAI.ResponsesMessageRole

A coleção de papéis válidos para os itens de mensagens de resposta.

Property Value
Description A coleção de papéis válidos para os itens de mensagens de resposta.
Type cadeia (de caracteres)
Values system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

Um item de parâmetro de mensagem com o system papel.

Name Tipo Description Required Default
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.

Name Tipo Description Required Default
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 o user papel.

Name Tipo Description Required Default
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.

Name Tipo Description Required Default
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

Name Tipo Description Required Default
grader objecto Um objeto StringCheckGrader que realiza uma comparação de strings entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. No
└─ evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 No
└─ graders objecto No
└─ image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
└─ input matriz O texto de entrada. Isto pode incluir cadeias de templates. No
└─ model cadeia (de caracteres) O modelo a usar para a avaliação. No
└─ name cadeia (de caracteres) O nome do avaliador. No
└─ operation enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 No
└─ range matriz A amplitude da partitura. Por defeito, é [0, 1]. No
└─ reference cadeia (de caracteres) O texto a ser avaliado. No
└─ sampling_params Os parâmetros de amostragem para o modelo. No
└─ source cadeia (de caracteres) O código-fonte do script Python. No
└─ type enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 No
item O item do conjunto de dados fornecido ao avaliador. Isto será usado para preencher o item namespace. No
model_sample cadeia (de caracteres) A amostra do modelo a ser avaliada. Este valor será usado para preencher o sample namespace.
A output_json variável será preenchida se a amostra do modelo for uma string JSON válida.		 Yes

OpenAI.RunGraderResponse

Name Tipo Description Required Default
metadados objecto Yes
└─ errors objecto No
└─ formula_parse_error boolean No
└─ invalid_variable_error boolean No
└─ model_grader_parse_error boolean No
└─ model_grader_refusal_error boolean No
└─ model_grader_server_error boolean No
└─ model_grader_server_error_details cadeia (de caracteres) No
└─ other_error boolean No
└─ python_grader_runtime_error boolean No
└─ python_grader_runtime_error_details cadeia (de caracteres) No
└─ python_grader_server_error boolean No
└─ python_grader_server_error_type cadeia (de caracteres) No
└─ sample_parse_error boolean No
└─ truncated_observation_error boolean No
└─ unresponsive_reward_error boolean No
└─ execution_time number No
└─ name cadeia (de caracteres) No
└─ sampled_model_name cadeia (de caracteres) No
└─ scores No
└─ token_usage número inteiro No
└─ type cadeia (de caracteres) No
model_grader_token_usage_per_model Yes
reward number Yes
sub_rewards Yes

OpenAI.StaticChunkingStrategy

Name Tipo Description Required Default
chunk_overlap_tokens número inteiro O número de tokens que se sobrepõem entre blocos. O valor padrão é 400.

Note-se 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 fichas em cada bloco. O valor padrão é 800. O valor mínimo é 100 e o valor máximo é 4096. Yes

OpenAI.StaticChunkingStrategyRequestParam

Personaliza a tua própria estratégia de chunks definindo o tamanho dos pedaços e a sobreposição dos blocos.

Name Tipo Description Required Default
estático OpenAI.StaticChunkingStrategy Yes
tipo enumeração Sempre static.
Valores possíveis: static		 Yes

OpenAI.StaticChunkingStrategyResponseParam

Name Tipo Description Required Default
estático OpenAI.StaticChunkingStrategy 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 em que a API deixa de gerar mais tokens. O texto devolvido não conterá a sequência de paragens.

Este esquema aceita um dos seguintes tipos:

  • string
  • array

OpenAI.Tool

Discriminador para OpenAI.Tool

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

Type Value Schema
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
Name Tipo Description Required Default
tipo OpenAI.ToolType Uma ferramenta que pode ser usada para gerar uma resposta. Yes

OpenAI.ToolChoiceObject

Discriminador para OpenAI.ToolChoiceObject

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

Type Value Schema
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
Name Tipo Description Required Default
tipo OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta incorporada para gerar uma resposta. Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: code_interpreter		 Yes

OpenAI.ToolChoiceObjectComputer

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: computer_use_preview		 Yes

OpenAI.ToolChoiceObjectFileSearch

Name Tipo Description Required Default
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.

Name Tipo Description Required Default
name cadeia (de caracteres) O nome da função a chamar. Yes
tipo enumeração Para chamadas de funções, o tipo é sempre function.
Valores possíveis: function		 Yes

OpenAI.ToolChoiceObjectImageGen

Name Tipo Description Required Default
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 num servidor MCP remoto.

Name Tipo Description Required Default
name cadeia (de caracteres) O nome da ferramenta para chamar no servidor. No
server_label cadeia (de caracteres) O rótulo do servidor MCP a usar. 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 incorporada para gerar uma resposta.

Property Value
Description Indica que o modelo deve usar uma ferramenta incorporada para gerar uma resposta.
Type cadeia (de caracteres)
Values file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

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

Name Tipo Description Required Default
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 chama nenhuma ferramenta e, em vez disso, gera uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo tem de chamar uma ou mais ferramentas.

Property Value
Description Controla qual (se houver) ferramenta chamada pelo modelo.

none significa que o modelo não chama nenhuma ferramenta e, em vez disso, gera uma mensagem.

auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.

required significa que o modelo tem de chamar uma ou mais ferramentas.
Type cadeia (de caracteres)
Values none
auto
required

OpenAI.ToolType

Uma ferramenta que pode ser usada para gerar uma resposta.

Property Value
Description Uma ferramenta que pode ser usada para gerar uma resposta.
Type cadeia (de caracteres)
Values file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell

OpenAI.TopLogProb

A probabilidade logarítmica máxima de um token.

Name Tipo Description Required Default
bytes matriz Yes
logprob number Yes
token cadeia (de caracteres) Yes

OpenAI.TranscriptionAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property Value
Type cadeia (de caracteres)
Values logprobs

OpenAI.TranscriptionSegment

Name Tipo Description Required Default
avg_logprob number Registo médio do segmento. Se o valor for inferior a -1, considere os logprobs falhados. Yes
compression_ratio number A taxa de compressão do segmento. Se o valor for superior a 2,4, considere que a compressão falhou. Yes
end number A hora final do segmento em segundos. Yes
id número inteiro Identificador único do segmento. Yes
no_speech_prob number Probabilidade de não haver fala no segmento. Se o valor for superior a 1,0 e o avg_logprob for inferior a -1, considere este segmento silencioso. Yes
seek número inteiro Procure o deslocamento do segmento. Yes
start number Começa o segmento em segundos. Yes
temperature number Parâmetro de temperatura usado para gerar o segmento. Yes
enviar SMS cadeia (de caracteres) Conteúdo textual do segmento. Yes
tokens matriz Array de IDs de token para o conteúdo de texto. Yes

OpenAI.TranscriptionWord

Name Tipo Description Required Default
end number A hora final da palavra em segundos. Yes
start number Começa a hora da palavra em segundos. Yes
word cadeia (de caracteres) O conteúdo do texto da palavra. Yes

OpenAI.TranslationAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. Yes

OpenAI.UpdateVectorStoreRequest

Name Tipo Description Required Default
expires_after objecto A política de expiração para uma loja vetorial. No
└─ anchor enumeração Carimbo temporal da âncora, após o qual se aplica a apólice de validade. Âncoras suportadas: last_active_at.
Valores possíveis: last_active_at		 No
└─ days número inteiro O número de dias após o tempo de ancoragem em que o armazenamento vetorial expirará. No
metadados objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 No
name cadeia (de caracteres) O nome da loja vetorial. No

OpenAI.VadConfig

Name Tipo Description Required Default
prefix_padding_ms número inteiro Quantidade de áudio a incluir antes do VAD detetar a fala (em milissegundos). No 300
silence_duration_ms número inteiro Duração do silêncio para detetar a paragem da fala (em milissegundos).
Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do utilizador.		 No 200
limiar number Limiar de sensibilidade (0.0 a 1.0) para deteção de atividade de voz. Um limiar mais elevado exigirá um áudio mais alto para ativar o modelo, podendo assim ter melhor desempenho em ambientes ruidosos. No 0.5
tipo enumeração Deve estar definido para server_vad permitir o chunking manual usando VAD do lado do servidor.
Valores possíveis: server_vad		 Yes

OpenAI.ValidateGraderRequest

Name Tipo Description Required Default
grader objecto Um objeto StringCheckGrader que realiza uma comparação de strings entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. No
└─ evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 No
└─ graders objecto No
└─ image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
└─ input matriz O texto de entrada. Isto pode incluir cadeias de templates. No
└─ model cadeia (de caracteres) O modelo a usar para a avaliação. No
└─ name cadeia (de caracteres) O nome do avaliador. No
└─ operation enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 No
└─ range matriz A amplitude da partitura. Por defeito, é [0, 1]. No
└─ reference cadeia (de caracteres) O texto a ser avaliado. No
└─ sampling_params Os parâmetros de amostragem para o modelo. No
└─ source cadeia (de caracteres) O código-fonte do script Python. No
└─ type enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 No

OpenAI.ValidateGraderResponse

Name Tipo Description Required Default
grader objecto Um objeto StringCheckGrader que realiza uma comparação de strings entre entrada e referência usando uma operação especificada. No
└─ calculate_output cadeia (de caracteres) Uma fórmula para calcular a saída com base nos resultados do avaliador. No
└─ evaluation_metric enumeração A métrica de avaliação a utilizar. Um de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4, , rouge_5, ou rouge_l.
Valores possíveis: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2rouge_3, rouge_4rouge_5rouge_l		 No
└─ graders objecto No
└─ image_tag cadeia (de caracteres) A tag de imagem a usar para o script em python. No
└─ input matriz O texto de entrada. Isto pode incluir cadeias de templates. No
└─ model cadeia (de caracteres) O modelo a usar para a avaliação. No
└─ name cadeia (de caracteres) O nome do avaliador. No
└─ operation enumeração A operação de verificação de string a realizar. Um de eq, ne, like, ou ilike.
Valores possíveis: eq, ne, like, ilike		 No
└─ range matriz A amplitude da partitura. Por defeito, é [0, 1]. No
└─ reference cadeia (de caracteres) O texto a ser avaliado. No
└─ sampling_params Os parâmetros de amostragem para o modelo. No
└─ source cadeia (de caracteres) O código-fonte do script Python. No
└─ type enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 No

OpenAI.VectorStoreExpirationAfter

A política de expiração para uma loja vetorial.

Name Tipo Description Required Default
âncora enumeração Carimbo temporal da âncora, após o qual se aplica a apólice de validade. Âncoras suportadas: last_active_at.
Valores possíveis: last_active_at		 Yes
days número inteiro O número de dias após o tempo de ancoragem em que o armazenamento vetorial expirará. Yes

OpenAI.VectorStoreFileAttributes

Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números.

Type: object

OpenAI.VectorStoreFileBatchObject

Um lote de ficheiros ligados a um armazenamento vetorial.

Name Tipo Description Required Default
created_at número inteiro O timestamp Unix (em segundos) para quando os ficheiros de armazenamento vetorial foram criados em lote. Yes
file_counts objecto Yes
└─ cancelled número inteiro O número de ficheiros que foram cancelados. No
└─ completed número inteiro O número de ficheiros que foram processados. No
└─ failed número inteiro O número de ficheiros que não foram processados. No
└─ in_progress número inteiro O número de ficheiros que estão atualmente a ser processados. No
└─ total número inteiro O número total de ficheiros. No
id cadeia (de caracteres) O identificador, que pode ser referenciado nos endpoints da 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 estado dos ficheiros de armazenamento vetorial em lote, que pode ser , in_progresscompleted, cancelled ou failed.
Valores possíveis: in_progress, completed, cancelled, failed		 Yes
vector_store_id cadeia (de caracteres) O ID do armazenamento vetorial a que o ficheiro está ligado. Yes

OpenAI.VectorStoreFileObject

Uma lista de ficheiros anexados a uma loja vetorial.

Name Tipo Description Required Default
attributes objecto Conjunto de 16 pares-chave-valor que podem ser anexados a um objeto. Isto pode ser útil para armazenar informação adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard. As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres, booleanos ou números. No
chunking_strategy objecto No
└─ type enumeração
Valores possíveis: static, other		 No
created_at número inteiro O carimbo temporal do Unix (em segundos) para quando o ficheiro de armazenamento vetorial foi criado. Yes
id cadeia (de caracteres) O identificador, que pode ser referenciado nos endpoints da API. Yes
last_error objecto O último erro associado a este ficheiro de armazenamento vetorial. Será null se não houver erros. Yes
└─ code enumeração Um de server_error ou rate_limit_exceeded.
Valores possíveis: server_error, unsupported_file, invalid_file		 No
└─ message cadeia (de caracteres) Uma descrição legível para humanos do erro. No
objecto enumeração O tipo de objeto, que é sempre vector_store.file.
Valores possíveis: vector_store.file		 Yes
estado enumeração O estado do ficheiro de armazenamento vetorial, que pode ser , in_progresscompleted, cancelled, ou failed. O estado completed indica que o ficheiro de armazenamento vetorial está pronto para uso.
Valores possíveis: in_progress, completed, cancelled, failed		 Yes
usage_bytes número inteiro A utilização total de vetores armazena em bytes. Note que isto pode ser diferente do tamanho original do ficheiro. Yes
vector_store_id cadeia (de caracteres) O ID do armazenamento vetorial a que o ficheiro está ligado. Yes

OpenAI.VectorStoreObject

Um armazenamento vetorial é uma coleção de ficheiros processados que podem ser usados pela file_search ferramenta.

Name Tipo Description Required Default
created_at número inteiro O carimbo de tempo Unix (em segundos) para quando a memória vetorial foi criada. Yes
expires_after OpenAI.VectorStoreExpirationAfter A política de expiração para uma loja vetorial. No
expires_at número inteiro O carimbo temporal do Unix (em segundos) indica quando a loja vetorial expira. No
file_counts objecto Yes
└─ cancelled número inteiro O número de ficheiros que foram cancelados. No
└─ completed número inteiro O número de ficheiros que foram processados com sucesso. No
└─ failed número inteiro O número de ficheiros que não foram processados. No
└─ in_progress número inteiro O número de ficheiros que estão atualmente a ser processados. No
└─ total número inteiro O número total de ficheiros. No
id cadeia (de caracteres) O identificador, que pode ser referenciado nos endpoints da API. Yes
last_active_at número inteiro O carimbo temporal do Unix (em segundos) indica quando o armazenamento vetorial esteve 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ção adicional sobre o objeto num formato estruturado e para consultar objetos através da API ou do dashboard.

As teclas são cadeias com um comprimento máximo de 64 caracteres. Os valores são cadeias com um comprimento máximo de 512 caracteres.		 Yes
name cadeia (de caracteres) O nome da loja vetorial. Yes
objecto enumeração O tipo de objeto, que é sempre vector_store.
Valores possíveis: vector_store		 Yes
estado enumeração O estado do armazenamento vetorial, que pode ser , expiredin_progress, ou completed. Um estado de completed indica que o armazenamento vetorial 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 ficheiros na loja vetorial. Yes

OpenAI.VoiceIdsShared

Property Value
Type cadeia (de caracteres)
Values alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Type Value Schema
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
Name Tipo Description Required Default
tipo OpenAI.WebSearchActionType Yes

OpenAI.WebSearchActionFind

Tipo de ação "encontrar": Pesquisa um padrão dentro de uma página carregada.

Name Tipo Description Required Default
padrão cadeia (de caracteres) O padrão ou texto a procurar dentro da página. Yes
tipo enumeração O tipo de ação.
Valores possíveis: find		 Yes
url cadeia (de caracteres) A URL da página procurava o padrão. Yes

OpenAI.WebSearchActionOpenPage

Tipo de ação "open_page" - Abre uma URL específica nos resultados de pesquisa.

Name Tipo Description Required Default
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 "pesquisa" - Realiza uma consulta de pesquisa na web.

Name Tipo Description Required Default
consulta cadeia (de caracteres) A consulta de pesquisa. Yes
tipo enumeração O tipo de ação.
Valores possíveis: search		 Yes

OpenAI.WebSearchActionType

Property Value
Type cadeia (de caracteres)
Values search
open_page
find

OpenAI.WebSearchPreviewTool

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

Name Tipo Description Required Default
search_context_size enumeração Orientação de alto nível para a quantidade de espaço de janela contextual a usar para a pesquisa. Um de low, medium, ou high. medium é o padrão.
Valores possíveis: low, medium, high		 No
tipo enumeração O tipo da ferramenta de pesquisa web. Um de web_search_preview ou web_search_preview_2025_03_11.
Valores possíveis: web_search_preview		 Yes
user_location objecto No
└─ type OpenAI.LocationType No

OpenAI.WebSearchToolCallItemParam

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

Name Tipo Description Required Default
ação objecto Yes
└─ type OpenAI.WebSearchActionType No
tipo enumeração
Valores possíveis: web_search_call		 Yes

OpenAI.WebSearchToolCallItemResource

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

Name Tipo Description Required Default
ação objecto Yes
└─ type OpenAI.WebSearchActionType No
estado enumeração O estado da ferramenta de pesquisa web chama.
Valores possíveis: in_progress, searching, completed, failed		 Yes
tipo enumeração
Valores possíveis: web_search_call		 Yes

PineconeChatDataSource

Name Tipo Description Required Default
parameters objecto A informação dos parâmetros para controlar a utilização da fonte de dados Pinecone. Yes
└─ allow_partial_result boolean Se definido como verdadeiro, o sistema permitirá a utilização de resultados de pesquisa parciais e o pedido falhará se todas as consultas parciais falharem. Se não for especificado ou especificado como falso, o pedido falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication objecto No
└─ key cadeia (de caracteres) No
└─ type enumeração
Valores possíveis: api_key		 No
└─ embedding_dependency objecto Uma representação de uma fonte de vetorização de dados utilizável como recurso de embedding com uma fonte de dados. No
└─ type AzureChatDataSourceVectorizationSourceType O identificador diferenciador para a fonte de vetorização do betão. No
└─ environment cadeia (de caracteres) O nome do ambiente a usar com Pinecone. No
└─ fields_mapping objecto Mapeamentos de campo para aplicar aos dados usados pela fonte de dados Pinecone.
Note que os mapeamentos de campos de conteúdo são obrigatórios para o Pinecone.		 No
└─ content_fields matriz No
└─ content_fields_separator cadeia (de caracteres) No
└─ filepath_field cadeia (de caracteres) No
└─ title_field cadeia (de caracteres) No
└─ url_field cadeia (de caracteres) No
└─ in_scope boolean Se as consultas devem ser restringidas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades do contexto de saída a incluir na resposta.
Por defeito, serão solicitadas citações e intenções.		 No ['citations', 'intent']
└─ index_name cadeia (de caracteres) O nome do índice da base de dados Pinecone a usar. No
└─ max_search_queries número inteiro O número máximo de consultas reescritas que devem ser enviadas ao fornecedor de pesquisa para uma única mensagem de utilizador.
Por defeito, o sistema fará uma determinação automática.		 No
└─ strictness número inteiro A rigidez configurada do filtro de relevância de pesquisa.
Maior rigor aumenta a precisão, mas reduz a recordação da resposta.		 No
└─ top_n_documents número inteiro O número configurado de documentos a destacar na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre 'pinha'.
Valores possíveis: pinecone		 Yes

Quality

A qualidade do conteúdo de vídeo a recuperar. Isto especifica a qualidade do conteúdo de vídeo que deve ser devolvido.

Property Value
Description A qualidade do conteúdo de vídeo a recuperar.
Isto especifica a qualidade do conteúdo de vídeo que deve ser devolvido.
Type cadeia (de caracteres)
Values high
low

ResponseFormatJSONSchemaRequest

Name Tipo Description Required Default
json_schema objecto Esquema JSON para o formato de resposta Yes
tipo enumeração Tipo de formato de resposta
Valores possíveis: json_schema		 Yes

ResponseModalities

Tipos de saída que gostaria que o modelo gerasse. A maioria dos modelos é capaz de gerar texto, que é o padrão:

["text"]

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

["text", "audio"]

Array de: string

SpeechGenerationResponseFormat

Os formatos de saída de áudio suportados para texto para fala.

Este componente pode ser um dos seguintes:

VideoGeneration

Um resultado de geração de vídeo.

Name Tipo Description Required Default
created_at número inteiro A época em que a geração de vídeo foi criada. Yes
height número inteiro O auge do vídeo. Yes
id cadeia (de caracteres) O id da geração de vídeo. Yes
job_id cadeia (de caracteres) O id do trabalho de geração de vídeo para este vídeo. Yes
n_seconds número inteiro A duração da geração de vídeo. Yes
objecto enumeração
Valores possíveis: video.generation		 Yes
avisar cadeia (de caracteres) O prompt para esta geração de vídeo. Yes
width número inteiro A largura do vídeo. Yes

VideoGenerationJob

Um trabalho de geração de vídeo.

Name Tipo Description Required Default
created_at número inteiro A altura em que o emprego foi criado. Yes
expires_at número inteiro O momento em que o trabalho é automaticamente eliminado do serviço. O conteúdo do vídeo e os metadados do trabalho devem ser armazenados antes desta data para evitar perda de dados. No
failure_reason string (ver modelos válidos abaixo) No
finished_at número inteiro A altura em que o trabalho terminou com todas as gerações de vídeo. No
generations matriz Os vídeos gerados para este trabalho. O número depende do n_variants dado e do sucesso da criação das gerações. No
height número inteiro O auge do vídeo. Yes
id cadeia (de caracteres) A identidade do trabalho. Yes
inpaint_items matriz Itens opcionais de pintura para este trabalho de geração de vídeo. No
modelo cadeia (de caracteres) O nome da implementação a usar para este trabalho de geração de vídeo. Yes
n_seconds número inteiro A duração do trabalho de geração de vídeo. Yes
n_variants número inteiro O número de vídeos a criar como variantes para este trabalho de geração de vídeo. Yes
objecto enumeração
Valores possíveis: video.generation.job		 Yes
avisar cadeia (de caracteres) O tema para este trabalho de geração de vídeo. Yes
estado objecto O estado de um trabalho de geração de vídeo. Yes
width número inteiro O auge do vídeo. Yes

VideoGenerationJobList

Uma lista de empregos de geração de vídeo.

Name Tipo Description Required Default
dados matriz A lista de empregos na geração de vídeo. Yes
first_id cadeia (de caracteres) O ID do primeiro emprego na página atual, se disponível. No
has_more boolean Uma bandeira a indicar se há mais empregos disponíveis após a lista. Yes
last_id cadeia (de caracteres) O ID do último emprego na página atual, se disponível. No
objecto enumeração
Valores possíveis: list		 Yes

Next steps

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

  • Last updated on