Azure OpenAI na referência de visualização da API REST de modelos de Microsoft Foundry v1

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

Inferência do plano de dados

O restante do artigo aborda nossa nova versão prévia da API v1 da especificação de inferência do plano de dados Azure OpenAI. Saiba mais em nosso guia de ciclo de vida da API.

Se você estiver procurando documentação sobre a versão mais recente da API ga v1, consulte a API de inferência do plano de dados ga mais recente

Create speech

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

Gera áudio de conversão de texto em fala do texto de entrada.

URI Parameters

Name In Required Tipo Description
ponto de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No O Microsoft versão explícita da API de Modelos de Fundimento a ser usada para essa solicitação.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
entrada cadeia O texto para o qual gerar áudio. O comprimento máximo é de 4.096 caracteres. Yes
instructions cadeia Controle a voz do áudio gerado com instruções adicionais. Não funciona com tts-1 ou tts-1-hd. No
modelo cadeia O modelo a ser usado para essa solicitação de conversão de texto em fala. Yes
response_format objeto Os formatos de saída de áudio com suporte para conversão de texto em fala. No
speed number A velocidade da fala do áudio gerado. Os valores são válidos no intervalo de 0,25 a 4,0, com 1,0 os valores padrão e mais altos correspondentes à fala mais rápida. No 1
stream_format enumeração O formato para transmitir o áudio. Os formatos com suporte são sse e audio. sse não há suporte para tts-1 ou tts-1-hd.
Valores possíveis: sse, audio		 No
voice objeto Yes

Responses

Código de status: 200

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

Content-Type Type Description
application/octet-stream cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Sintetiza o áudio 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 Status: 200

{
  "body": "101010101"
}

Create transcription

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

Transcreve o áudio no idioma de entrada.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
chunking_strategy objeto No
└─ prefix_padding_ms inteiro Quantidade de áudio a ser incluída antes da fala detectada pelo VAD (em milissegundos). No 300
└─ silence_duration_ms inteiro Duração do silêncio para detectar a parada de fala (em milissegundos). Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do usuário. No 200
└─ threshold number Limite de confidencialidade (0,0 a 1,0) para detecção de atividade de voz. Um limite mais alto exigirá um áudio mais alto para ativar o modelo e, portanto, poderá ter um desempenho melhor em ambientes barulhentos. No 0.5
└─ type enumeração Deve ser definido para server_vad habilitar o agrupamento manual usando o VAD do lado do servidor.
Valores possíveis: server_vad		 No
arquivo cadeia Yes
filename cadeia O nome de arquivo opcional ou o identificador descritivo a ser associado aos dados de áudio. No
include[] matriz Informações adicionais a serem incluídas na resposta de transcrição. logprobs retornará as probabilidades de log dos tokens na resposta para entender a confiança do modelo na transcrição. logprobssó funciona com response_format definidos json como e somente com os modelosgpt-4o-transcribe, gpt-4o-transcribe-diarizee gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15. No
linguagem cadeia O idioma do áudio de entrada. Fornecer o idioma de entrada no formato ISO-639-1 (por exemplo en) melhorará a precisão e a latência. No
modelo cadeia O modelo a ser usado para essa solicitação de transcrição. No
solicitação cadeia Um texto opcional para orientar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve corresponder ao idioma de áudio. No
response_format objeto No
fluxo boolean Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. Observação: o streaming não tem suporte 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, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico. Se definido como 0, o modelo usará a probabilidade de log para aumentar automaticamente a temperatura até que determinados limites sejam atingidos. No 0
timestamp_granularities[] matriz As granularidades de carimbo de data/hora a serem preenchidas para essa transcrição. response_format deve ser definido verbose_json para usar granularidades de carimbo de data/hora. Há suporte para ambas ou ambas as opções: wordou segment. Observação: não há latência adicional para carimbos de data/hora do segmento, mas gerar carimbos de data/hora de palavra incorre em latência adicional. No ['segment']

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureAudioTranscriptionResponse
text/plain cadeia

Código de Status: 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 de dados de áudio falados fornecidos.

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

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

Respostas: Código de Status: 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 de dados de áudio falados fornecidos.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
arquivo cadeia Yes
filename cadeia O nome de arquivo opcional ou o identificador descritivo a ser associado aos dados de áudio No
modelo cadeia O modelo a ser usado para essa solicitação de tradução. No
solicitação cadeia Um texto opcional para orientar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve estar em inglês. No
response_format objeto No
temperature number A temperatura de amostragem, entre 0 e 1. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico. Se definido como 0, o modelo usará a probabilidade de log para aumentar automaticamente a temperatura até que determinados limites sejam atingidos. No 0

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureAudioTranslationResponse
text/plain cadeia

Código de Status: 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 de dados de áudio falados fornecidos.

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

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

Respostas: Código de Status: 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 de chat.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
audio objeto Parâmetros para saída de áudio. Necessá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 de wav, mp3, ,flacopus, ou pcm16.
Valores possíveis: wav, , aac, mp3, flac, , opuspcm16		 No
└─ voice objeto No
data_sources matriz As fontes de dados a serem usadas para o recurso On Your Data, exclusivo para Azure OpenAI. No
frequency_penalty number Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua frequência existente no texto até agora, diminuindo a probabilidade do modelo repetir a mesma linha verbatim. No 0
function_call enumeração Especificar uma função específica por meio {"name": "my_function"} de força o modelo a chamar essa função.
Valores possíveis: none, auto		 No
functions matriz Preterido em favor de tools.
Uma lista de funções para as quais o modelo pode gerar entradas JSON.		 No
logit_bias objeto Modifique a probabilidade de tokens especificados aparecerem na conclusão. Aceita um objeto JSON que mapeia tokens (especificados por sua ID de token no tokenizer) para um valor de viés associado de -100 para 100. Matematicamente, o viés é adicionado aos logits gerados pelo modelo antes da amostragem. O efeito exato variará por modelo, mas os valores entre -1 e 1 devem diminuir ou aumentar a probabilidade de seleção; valores como -100 ou 100 devem resultar em uma proibição ou seleção exclusiva do token relevante. No None
logprobs boolean Se deseja retornar probabilidades de log dos tokens de saída ou não. Se for true, retornará as probabilidades de log de cada token de saída retornado no content valor de message. No False
max_completion_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma conclusão, incluindo tokens de saída visíveis e tokens de raciocínio. No
max_tokens inteiro O número máximo de tokens que podem ser gerados na conclusão do chat.
Esse valor pode ser usado para controlar os custos do texto gerado por meio da API.
Esse valor agora foi preterido em favor de max_completion_tokens, e não é compatível com modelos da série o1.		 No
messages matriz Uma lista de mensagens que compõem a conversa até agora. Dependendo do modelo usado, há suporte para diferentes tipos de mensagens (modalidades), como texto, imagens e áudio. Yes
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.
As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
modalities objeto Tipos de saída que você gostaria que o modelo gerasse.
A maioria dos modelos é capaz de gerar texto, que é o padrão:

["text"]

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

["text", "audio"]		 No
modelo cadeia O identificador de implantação de modelo a ser usado para a solicitação de conclusão do chat. Yes
n inteiro Quantas opções de conclusão de chat serão geradas para cada mensagem de entrada. Observe que você será cobrado com base no número de tokens gerados em todas as opções. Mantenha n como 1 minimizar os custos. No 1
parallel_tool_calls objeto Se deseja habilitar a chamada de função paralela durante o uso da ferramenta. No
previsão objeto Representação base da saída prevista 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 se eles aparecem no texto até agora, aumentando a probabilidade do modelo falar sobre novos tópicos. No 0
reasoning_effort objeto somente modelos da série o

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
response_format objeto No
└─ type enumeração
Valores possíveis: text, , json_objectjson_schema		 No
seed inteiro Esse recurso está em Beta.
Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que solicitações repetidas com o mesmo seed e parâmetros devem retornar o mesmo resultado.
O determinismo não é garantido e você deve se referir ao system_fingerprint parâmetro de resposta para monitorar as alterações no back-end.		 No
stop objeto Não há suporte para modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências em que a API deixará de gerar tokens adicionais. O texto retornado não conterá a sequência de interrupção.		 No
armazenar boolean Se deseja ou não armazenar a saída dessa solicitação de conclusão de chat para uso em produtos de destilação ou avaliação de modelo. No False
fluxo boolean Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. No False
stream_options objeto Opções para resposta de streaming. Defina isso somente quando você definir stream: true. No
└─ include_usage boolean Se definido, uma parte adicional será transmitida antes da data: [DONE] mensagem. O usage campo nessa parte mostra as estatísticas de uso do token para toda a solicitação e o choices campo sempre será uma matriz vazia.

Todas as outras partes também incluirão um usage campo, mas com um valor nulo. NOTA: Se o fluxo for interrompido, você poderá não receber a parte de uso final que contém o uso total do token para a solicitação.		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual ferramenta (se houver) é chamada pelo modelo.
none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.
required significa que o modelo deve chamar uma ou mais ferramentas.
Especificar uma ferramenta específica por meio {"type": "function", "function": {"name": "my_function"}} de força o modelo a chamar essa ferramenta.

none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.		 No
tools matriz Uma lista de ferramentas que o modelo pode chamar. Atualmente, há suporte apenas para funções como uma ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. Há suporte para um máximo de 128 funções. No
top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No 1
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar a monitorar e detectar abusos. No
user_security_context AzureUserSecurityContext O contexto de segurança do usuário contém vários parâmetros que descrevem o próprio aplicativo e o usuário final que interage com o aplicativo. Esses campos ajudam suas equipes de operações de segurança a investigar e mitigar incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Learn mais sobre como proteger aplicativos de IA usando Microsoft Defender para Nuvem. No

Responses

Código de status: 200

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

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

Código de Status: 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 Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Create embedding

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

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

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.CreateEmbeddingResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Retorne as inserções 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 Status: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

List evals

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

Listar avaliações para um projeto.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.EvalList

Código de Status: 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 pode ser usada para testar o desempenho de um modelo.

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
data_source_config objeto Yes
└─ type OpenAI.EvalDataSourceConfigType No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

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

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.Eval

Código de Status: 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 por sua ID. Recupera uma avaliação por sua ID.

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.Eval

Código de Status: 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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

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. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

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

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.Eval

Código de Status: 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

Exclua uma avaliação especificada.

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json objeto

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obter execuções de avaliação

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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar execução de avaliação

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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
data_source objeto Yes
└─ type OpenAI.EvalRunDataSourceType No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
name cadeia O nome da execução. No

Responses

Código de status: 201

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

Content-Type Type Description
application/json OpenAI.EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obter execução de avaliação

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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Cancelar execução de avaliação

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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.EvalRun

Código de Status: 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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json objeto

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItemList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

OBSERVAÇÃO: Esta Azure API openai está em versão prévia e está sujeita a alterações.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.EvalRunOutputItem

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
expires_after objeto Yes
└─ anchor AzureFileExpiryAnchor No
└─ seconds inteiro No
arquivo cadeia Yes
purpose enumeração A finalidade pretendida do arquivo carregado. Um de: - assistants: Usado na API de Assistentes - batch: Usado na API do Lote - fine-tune: Usado para ajuste fino - evals: Usado para conjuntos de dados de avaliação
Valores possíveis: assistants, , batch, fine-tuneevals		 Yes

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
purpose consulta No cadeia

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureListFilesResponse

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
file_id caminho Yes cadeia A ID do arquivo a ser usado para essa solicitação.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureOpenAIFile

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
file_id caminho Yes cadeia A ID do arquivo a ser usado para essa solicitação.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.DeleteFileResponse

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
file_id caminho Yes cadeia A ID do arquivo a ser usado para essa solicitação.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/octet-stream cadeia

Código de Status: 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

Execute um classificador.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
grader objeto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. No
└─ evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 No
└─ graders objeto No
└─ image_tag cadeia A marca de imagem a ser usada para o script python. No
└─ input matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. No
└─ model cadeia O modelo a ser usado para a avaliação. No
└─ name cadeia O nome do classificador. No
└─ operation enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 No
└─ range matriz O intervalo da pontuação. O padrão é [0, 1]. No
└─ reference cadeia O texto que está sendo classificado. No
└─ sampling_params Os parâmetros de amostragem do modelo. No
└─ source cadeia 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 de conjunto de dados fornecido ao classificador. Isso será usado para preencher o item namespace. No
model_sample cadeia O exemplo de modelo a ser avaliado. Esse valor será usado para preencher o sample namespace.
A output_json variável será preenchida se o exemplo de modelo for uma cadeia de caracteres JSON válida.		 Yes

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.RunGraderResponse

Código de Status: 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

Valide um classificador.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
grader objeto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. No
└─ evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 No
└─ graders objeto No
└─ image_tag cadeia A marca de imagem a ser usada para o script python. No
└─ input matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. No
└─ model cadeia O modelo a ser usado para a avaliação. No
└─ name cadeia O nome do classificador. No
└─ operation enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 No
└─ range matriz O intervalo da pontuação. O padrão é [0, 1]. No
└─ reference cadeia O texto que está sendo classificado. No
└─ sampling_params Os parâmetros de amostragem do modelo. No
└─ source cadeia 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 status: 200

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

Content-Type Type Description
application/json OpenAI.ValidateGraderResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar um trabalho de ajuste fino

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

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
hyperparameters objeto Os hiperparâmetros usados para o trabalho de ajuste fino.
Esse valor agora foi preterido 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 habilitar seu trabalho de ajuste fino. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
método OpenAI.FineTuneMethod O método usado para ajuste fino. No
modelo cadeia de caracteres (veja os modelos válidos abaixo) O nome do modelo a ser afinado. Yes
seed inteiro A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros de semente e trabalho deve produzir os mesmos resultados, mas pode ser diferente em casos raros.
Se uma semente não for especificada, uma será gerada para você.		 No
suffix cadeia Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado.

Por exemplo, um suffix "custom-model-name" produziria um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No None
training_file cadeia A ID de um arquivo carregado que contém dados de treinamento. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade fine-tune.

O conteúdo do arquivo deve ser diferente dependendo se o modelo usar o chat, o formato de conclusão ou se o método de ajuste fino usar o formato de preferência.		 Yes
validation_file cadeia A ID de um arquivo carregado que contém dados de validação.

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

Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade fine-tune.		 No

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listar trabalhos de ajuste fino paginados

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListPaginatedFineTuningJobsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Recuperar trabalho de ajuste fino

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Cancelar trabalho de ajuste fino

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

Cancele imediatamente um trabalho de ajuste fino.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

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

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobCheckpointsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listar eventos de ajuste fino

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListFineTuningJobEventsResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Pausar o trabalho de ajuste fino

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

Pausar um trabalho de ajuste fino.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Retomar o trabalho de ajuste fino

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

Retome um trabalho de ajuste fino em pausa.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.FineTuningJob

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
em segundo plano enumeração Permite definir a transparência para a tela de fundo das imagens geradas.
Esse parâmetro só tem suporte para gpt-image-1 modelos. Deve ser um ou transparentopaqueauto (valor padrão). Quando auto for usado, o modelo determinará automaticamente o melhor plano de fundo para a imagem.

Se transparent, o formato de saída precisa dar suporte à transparência, portanto, ele deve ser definido como png (valor padrão) ou webp.
Valores possíveis: transparent, , opaqueauto		 No
imagem cadeia de caracteres ou matriz Yes
máscara cadeia No
modelo cadeia A implantação de modelo a ser usada para a operação de edição de imagem. Yes
n inteiro O número de imagens a serem geradas. Deve estar entre 1 e 10. No 1
output_compression inteiro O nível de compactação (0-100%) para as imagens geradas. Esse parâmetro só tem suporte para gpt-image-1modelos de série com os webp formatos ou jpeg saída e usa como padrão 100. No 100
output_format enumeração O formato no qual as imagens geradas são retornadas. Esse parâmetro só tem suporte para gpt-image-1modelos de série. Deve ser um de png, jpegou webp.
O valor padrão é png.
Valores possíveis: png, , jpegwebp		 No
solicitação cadeia Uma descrição de texto das imagens desejadas. O comprimento máximo é de 1.000 caracteres e dall-e-23.2000 caracteres para gpt-image-1modelos da série. Yes
quality enumeração A qualidade da imagem que será gerada. high, medium e low só têm suporte para gpt-image-1modelos de série. dall-e-2 só dá suporte à standard qualidade. O padrão é auto.
Valores possíveis: standard, , low, medium, high, auto		 No
response_format enumeração O formato no qual as imagens geradas são retornadas. Deve ser um de url ou b64_json. As URLs só são válidas por 60 minutos após a geração da imagem. Esse parâmetro só tem suporte para dall-e-2modelos de série, pois gpt-image-1os modelos de série sempre retornarão imagens codificadas em 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 de série e um de 256x256, 512x512ou 1024x1024 para dall-e-2.
Valores possíveis: 256x256, , 512x512, 1024x1024, 1536x1024, , 1024x1536auto		 No
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureImagesResponse

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
em segundo plano enumeração Permite definir a transparência para a tela de fundo das imagens geradas.
Esse parâmetro só tem suporte para gpt-image-1 modelos. Deve ser um ou transparentopaqueauto (valor padrão). Quando auto for usado, o modelo determinará automaticamente o melhor plano de fundo para a imagem.

Se transparent, o formato de saída precisa dar suporte à transparência, portanto, ele deve ser definido como png (valor padrão) ou webp.
Valores possíveis: transparent, , opaqueauto		 No
modelo cadeia A implantação de modelo a ser usada para a geração de imagem. Yes
moderation enumeração Controlar o nível de moderação de conteúdo para imagens geradas por gpt-image-1modelos de série. Deve ser low para filtragem menos restritiva ou auto (valor padrão).
Valores possíveis: low, auto		 No
n inteiro O número de imagens a serem geradas. Deve estar entre 1 e 10. Para dall-e-3, só n=1 há suporte. No 1
output_compression inteiro O nível de compactação (0-100%) para as imagens geradas. Esse parâmetro só tem suporte para gpt-image-1modelos de série com os webp formatos ou jpeg saída e usa como padrão 100. No 100
output_format enumeração O formato no qual as imagens geradas são retornadas. Esse parâmetro só tem suporte para gpt-image-1modelos de série. Deve ser um de png, jpegou webp.
Valores possíveis: png, , jpegwebp		 No
solicitação cadeia Uma descrição de texto das imagens desejadas. O comprimento máximo é de 32.000 caracteres para gpt-image-1modelos da série, 1.000 caracteres e dall-e-2 4.000 caracteres para dall-e-3. Yes
quality enumeração A qualidade da imagem que será gerada.

- auto (valor padrão) selecionará automaticamente a melhor qualidade para o modelo fornecido.
- high medium e low são compatíveis com gpt-image-1modelos de série.
- hd e standard têm suporte para dall-e-3.
- standard é a única opção para dall-e-2.
Valores possíveis: standard, , hd, low, medium, , highauto		 No
response_format enumeração O formato no qual as imagens geradas são dall-e-2 retornadas e dall-e-3 retornadas. Deve ser um de url ou b64_json. As URLs só são válidas por 60 minutos após a geração da imagem. Esse parâmetro não tem suporte para gpt-image-1modelos de série que sempre retornarão imagens codificadas em 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 de série, um de 256x256, 512x512ou 1024x1024 para dall-e-2, e um de 1024x1024, 1792x1024ou 1024x1792 para dall-e-3.
Valores possíveis: auto, , 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, , , 1792x10241024x1792		 No
estilo enumeração O estilo das imagens geradas. Esse parâmetro só tem suporte para dall-e-3. Deve ser um de vivid ou natural. O Vivid 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 e menos hiper-reais.
Valores possíveis: vivid, natural		 No
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureImagesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Cria imagens fornecidas por 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 Status: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "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 disponíveis no momento e fornece informações básicas sobre cada um deles, como o proprietário e a disponibilidade.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListModelsResponse

Código de Status: 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 de modelo, fornecendo informações básicas sobre o modelo, como o proprietário e permissões.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.Model

Código de Status: 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 de modelo.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
em segundo plano boolean Se a resposta do modelo deve ser executada em segundo plano. No False
include matriz Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores com suporte no momento são:
- code_interpreter_call.outputs: inclui as saídas da execução de código python em itens de chamada de ferramenta de interpretador de código.
- computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
- file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
- message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
- message.output_text.logprobs: inclua logprobs com mensagens de assistente.
- reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o store parâmetro é definido falsecomo , ou quando uma organização é registrada no programa de retenção de dados zero).		 No
entrada cadeia de caracteres ou matriz No
instructions cadeia Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
modelo cadeia A implantação do modelo a ser usada para a criação dessa resposta. Yes
parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
solicitação objeto Referência a um modelo de prompt e suas variáveis. No
└─ id cadeia O identificador exclusivo do modelo de prompt a ser usado. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. No
└─ version cadeia Versão opcional do modelo de prompt. No
reasoning objeto somente modelos da série o

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

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
└─ generate_summary enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
└─ summary enumeração Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
armazenar boolean Se deseja armazenar a resposta do modelo gerado para recuperação posterior por meio da API. No True
fluxo boolean Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem 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, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No 1
enviar SMS objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objeto Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

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

required significa que o modelo deve chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. No
tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. You
pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo, como a pesquisa de arquivos.
- Chamadas de função (ferramentas personalizadas): Funções definidas por você, permitindo que o modelo chame seu próprio código.		 No
top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

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

Responses

Código de status: 200

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

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

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

Example

Criar uma resposta de modelo

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

Get response

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

Recupera uma resposta de modelo com a ID fornecida.

URI Parameters

Name In Required Tipo Description
ponto de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
response_id caminho Yes cadeia
include[] consulta No matriz

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json AzureResponse

Código de Status: 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

Exclui uma resposta por ID.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json objeto

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listar itens de entrada

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ResponseItemList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listar repositórios de vetores

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

Retorna uma lista de repositórios de vetores.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoresResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar repositório de vetores

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

Cria um repositório de vetores.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
chunking_strategy objeto A estratégia padrão. Atualmente, essa estratégia usa um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400. 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 de um repositório de vetores. No
file_ids matriz Uma lista de IDs de arquivo que o repositório de vetores deve usar. Útil para ferramentas como file_search essa que podem acessar arquivos. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
name cadeia O nome do repositório de vetores. No

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Examples

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

Obter repositório de vetores

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

Recupera um repositório de vetores.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Modificar o repositório de vetores

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

Modifica um repositório de vetores.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
expires_after objeto A política de expiração de um repositório de vetores. No
└─ anchor enumeração Carimbo de data/hora de âncora após o qual a política de expiração se aplica. Âncoras com suporte: last_active_at.
Valores possíveis: last_active_at		 No
└─ days inteiro O número de dias após o tempo de ancoragem em que o repositório de vetores expirará. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
name cadeia O nome do repositório de vetores. No

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Excluir repositório de vetores

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

Excluir um repositório de vetores.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar lote de arquivos do repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
attributes objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, boolianos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de agrupamento usada para agrupar os arquivos. Se não estiver definido, usará a auto estratégia. No
file_ids matriz Uma lista de IDs de arquivo que o repositório de vetores deve usar. Útil para ferramentas como file_search essa que podem acessar arquivos. Yes

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obter o lote de arquivos do repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Cancelar lote de arquivos do repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileBatchObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listar arquivos no lote do repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Listar arquivos do repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.ListVectorStoreFilesResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Criar arquivo de repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
attributes objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, boolianos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de agrupamento usada para agrupar os arquivos. Se não estiver definido, usará a auto estratégia. No
file_id cadeia Uma ID de arquivo que o repositório de vetores deve usar. Útil para ferramentas como file_search essa que podem acessar arquivos. Yes

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Obter o arquivo de repositório de vetores

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

Recupera um arquivo de repositório de vetores.

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Atualizar atributos de arquivo do repositório de vetores

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

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

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.VectorStoreFileObject

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Excluir arquivo de repositório de vetores

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

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

URI Parameters

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

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json OpenAI.DeleteVectorStoreFileResponse

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureErrorResponse

Trabalhos de 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Request Body

Content-Type: application/json

Name Tipo Description Required Default
height inteiro A altura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes
modelo cadeia O nome da implantação a ser usada para essa solicitação. Yes
n_seconds inteiro A duração do trabalho de geração de vídeo. Deve estar entre 1 e 20 segundos. No 5
n_variants inteiro O número de vídeos a serem criados como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
solicitação cadeia O prompt para este trabalho de geração de vídeo. Yes
width inteiro A largura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes

Request Body

Content-Type: multipart/form-data

Name Tipo Description Required Default
files matriz Yes
height inteiro A altura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes
inpaint_items matriz Itens de insintação opcionais para este trabalho de geração de vídeo. No
modelo cadeia O nome da implantação a ser usada para essa solicitação. Yes
n_seconds inteiro A duração do trabalho de geração de vídeo. Deve estar entre 1 e 20 segundos. No 5
n_variants inteiro O número de vídeos a serem criados como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
solicitação cadeia O prompt para este trabalho de geração de vídeo. Yes
width inteiro A largura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes

Responses

Código de status: 200

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

Content-Type Type Description
application/json VideoGenerationJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

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

Trabalhos de geração de vídeo – Lista

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

Lista os trabalhos de geração de vídeo.

URI Parameters

Name In Required Tipo Description
ponto de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
before consulta No cadeia
after consulta No cadeia
limit consulta Yes inteiro
statuses consulta No matriz

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json VideoGenerationJobList

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

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

Trabalhos de geração de vídeo – Obter

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

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

URI Parameters

Name In Required Tipo Description
ponto de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
job-id caminho Yes cadeia A ID do trabalho de geração de vídeo a ser usada para a solicitação Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json VideoGenerationJob

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

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

Trabalhos de geração de vídeo – Excluir

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

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

URI Parameters

Name In Required Tipo Description
ponto de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
job-id caminho Yes cadeia A ID do trabalho de geração de vídeo a ser usada para a solicitação Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 204

Descrição: não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
application/json VideoGeneration

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Examples

Arquivo 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
image/jpg cadeia

Código de Status: 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 de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.
quality consulta No

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Content-Type Type Description
video/mp4 cadeia

Código de Status: padrão

Descrição: uma resposta de erro inesperada.

Content-Type Type Description
application/json AzureOpenAIVideoGenerationErrorResponse

Gerações de vídeo – recuperar somente cabeçalhos de videocontent

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

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

URI Parameters

Name In Required Tipo Description
ponto de extremidade caminho Yes cadeia
url		 Com suporte Azure pontos de extremidade OpenAI (protocolo e nome do host, por exemplo: https://aoairesource.openai.azure.com. Substitua "aoairesource" pelo Azure nome do recurso OpenAI). https://{your-resource-name}.openai.azure.com
api-version consulta No A versão explícita da API de Modelos do Foundry a ser usada para essa solicitação.
v1 se não for especificado de outra forma.
generation-id caminho Yes cadeia A ID da geração de vídeo a ser usada para a solicitação Azure OpenAI.
quality consulta No

Request Header

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

Name Required Tipo Description
Authorization True cadeia 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
Escopo: https://ai.azure.com/.default
api-key True cadeia Forneça Azure chave de API openai aqui

Responses

Código de status: 200

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

Código de Status: 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ção de áudio disponíveis.

Property Value
Description Define os possíveis descritores para respostas de operação de áudio disponíveis.
Type cadeia
Values transcribe
translate

AudioTranslationSegment

Informações estendidas sobre um único segmento de dados de áudio traduzidos. Os segmentos geralmente representam cerca de 5 a 10 segundos de fala. Normalmente, os limites de segmento ocorrem entre palavras, mas não necessariamente frases.

Name Tipo Description Required Default
avg_logprob number A probabilidade média de log associada a este segmento de áudio. Yes
compression_ratio number A taxa de compactação desse segmento de áudio. Yes
end number A hora em que esse segmento terminou em relação ao início do áudio traduzido. Yes
id inteiro O índice baseado em 0 desse segmento em uma tradução. Yes
no_speech_prob number A probabilidade de nenhuma detecção de fala nesse segmento de áudio. Yes
seek inteiro A posição de busca associada ao processamento desse segmento de áudio.
As posições de busca são expressas como centésimos de segundos.
O modelo pode processar vários segmentos de uma única posição de busca, portanto, embora a posição de busca nunca represente um horário posterior ao início do segmento, o início do segmento pode representar um tempo significativamente mais tarde do que a posição de busca associada do segmento.		 Yes
start number A hora em que esse segmento começou em relação ao início do áudio traduzido. Yes
temperature number A pontuação de temperatura associada a este segmento de áudio. Yes
enviar SMS cadeia O texto traduzido que fazia parte desse segmento de áudio. Yes
tokens matriz As IDs de token que correspondem ao texto traduzido neste segmento de áudio. Yes

AzureAIFoundryModelsApiVersion

Property Value
Type cadeia
Values v1
preview

AzureAudioTranscriptionResponse

Informações de resultado de uma operação que transscreveu áudio falado em texto escrito.

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

AzureAudioTranslationResponse

Informações de resultado de uma operação que traduziu áudio falado em texto escrito.

Name Tipo Description Required Default
duration number A duração total do áudio processado para produzir informações de tradução que acompanham. No
linguagem cadeia O idioma falado detectado nos dados de áudio traduzidos.
Isso é expresso como um código de idioma ISO-639-1 de duas letras, como 'en' ou 'fr'.		 No
segments matriz Uma coleção de informações sobre o tempo, as probabilidades e outros detalhes de cada segmento de áudio processado. No
tarefa objeto Define os possíveis descritores para respostas de operação de áudio disponíveis. No
enviar SMS cadeia O texto traduzido para os dados de á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. Esse modelo adiciona suporte para o contexto de mensagem de chat, usado pelo recurso On Your Data para intenção, citações e outras informações relacionadas à geração aumentada de recuperação executada.

Name Tipo Description Required Default
annotations matriz Anotações para a mensagem, quando aplicável, como ao usar a ferramenta de pesquisa na Web. No
audio objeto Se a modalidade de saída de áudio for solicitada, esse objeto conterá dados sobre a resposta de áudio do modelo. No
└─ data cadeia Bytes de áudio codificados em Base64 gerados pelo modelo, no formato especificado na solicitação. No
└─ expires_at inteiro O carimbo de data/hora unix (em segundos) para quando essa resposta de áudio não estará mais acessível no servidor para uso em conversas de vários turnos. No
└─ id cadeia Identificador exclusivo para essa resposta de áudio. No
└─ transcript cadeia Transcrição do áudio gerado pelo modelo. No
conteúdo cadeia O conteúdo da mensagem. Yes
contexto objeto Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzidas pelo serviço Azure OpenAI ao usar o comportamento da extensão. Isso inclui informações de intenção e citação do recurso On Your Data. No
└─ all_retrieved_documents objeto Informações resumidas sobre documentos recuperados pela operação de recuperação de dados. No
└─ chunk_id cadeia A ID da parte da citação. No
└─ content cadeia O conteúdo da citação. No
└─ data_source_index inteiro O índice da fonte de dados usada para recuperação. No
└─ filepath cadeia O caminho do arquivo para a citação. No
└─ filter_reason enumeração Se aplicável, uma indicação de por que o documento foi filtrado.
Valores possíveis: score, rerank		 No
└─ original_search_score number A pontuação de pesquisa original para a recuperação. No
└─ rerank_score number A pontuação de reclassificado para a recuperação. No
└─ search_queries matriz As consultas de pesquisa executadas para recuperar documentos. No
└─ title cadeia O título da citação. No
└─ url cadeia A URL da citação. No
└─ citations matriz As citações produzidas pela recuperação de dados. No
└─ intent cadeia A intenção detectada do histórico de chat, que é usado para levar o contexto da conversa entre interações No
function_call objeto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. No
└─ arguments cadeia No
└─ name cadeia No
reasoning_content cadeia Uma propriedade de extensão específica Azure que contém o conteúdo de raciocínio gerado de modelos com suporte. No
refusal cadeia A mensagem de recusa gerada pelo modelo. Yes
função enumeração A função do autor desta mensagem.
Valores possíveis: assistant		 Yes
tool_calls ChatCompletionMessageToolCallsItem As chamadas de ferramenta geradas pelo modelo, como chamadas de função. No

AzureChatCompletionStreamResponseDelta

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

Name Tipo Description Required Default
audio objeto No
└─ data cadeia No
└─ expires_at inteiro No
└─ id cadeia No
└─ transcript cadeia No
conteúdo cadeia O conteúdo da mensagem de parte. No
contexto objeto Uma propriedade adicional, adicionada às mensagens de resposta de conclusão de chat, produzidas pelo serviço Azure OpenAI ao usar o comportamento da extensão. Isso inclui informações de intenção e citação do recurso On Your Data. No
└─ all_retrieved_documents objeto Informações resumidas sobre documentos recuperados pela operação de recuperação de dados. No
└─ chunk_id cadeia A ID da parte da citação. No
└─ content cadeia O conteúdo da citação. No
└─ data_source_index inteiro O índice da fonte de dados usada para recuperação. No
└─ filepath cadeia O caminho do arquivo para a citação. No
└─ filter_reason enumeração Se aplicável, uma indicação de por que o documento foi filtrado.
Valores possíveis: score, rerank		 No
└─ original_search_score number A pontuação de pesquisa original para a recuperação. No
└─ rerank_score number A pontuação de reclassificado para a recuperação. No
└─ search_queries matriz As consultas de pesquisa executadas para recuperar documentos. No
└─ title cadeia O título da citação. No
└─ url cadeia A URL da citação. No
└─ citations matriz As citações produzidas pela recuperação de dados. No
└─ intent cadeia A intenção detectada do histórico de chat, que é usado para levar o contexto da conversa entre interações No
function_call objeto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. No
└─ arguments cadeia No
└─ name cadeia No
reasoning_content cadeia Uma propriedade de extensão específica Azure que contém o conteúdo de raciocínio gerado de modelos com suporte. No
refusal cadeia A mensagem de recusa gerada pelo modelo. No
função objeto A função 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. Isso será usado por uma solicitação de conclusão de chat que deve usar Azure extensões de chat openai para aumentar o comportamento da resposta. O uso dessa configuração é compatível apenas com Azure OpenAI.

Discriminador para a AzureChatDataSource

Esse componente usa 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 objeto Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

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

AzureChatDataSourceApiKeyAuthenticationOptions

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

AzureChatDataSourceAuthenticationOptions

Discriminador para AzureChatDataSourceAuthenticationOptions

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

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
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 Yes
tipo enumeração
Valores possíveis: connection_string		 Yes

AzureChatDataSourceDeploymentNameVectorizationSource

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

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

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

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

AzureChatDataSourceEndpointVectorizationSource

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

Name Tipo Description Required Default
autenticação objeto Yes
└─ access_token cadeia No
└─ key cadeia No
└─ type enumeração
Valores possíveis: access_token		 No
dimensions inteiro O número de dimensões a serem solicitadas em inserções.
Só há suporte em modelos "text-embedding-3" e posteriores.		 No
ponto de extremidade cadeia Especifica a URL do ponto de extremidade de recurso da qual as inserções devem ser recuperadas.
Ele deve estar no formato de:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
O parâmetro de consulta de versão de api não é permitido.		 Yes
tipo enumeração O identificador de tipo, sempre "ponto de extremidade" para esse tipo de origem de vetorização.
Valores possíveis: endpoint		 Yes

AzureChatDataSourceIntegratedVectorizationSource

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

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

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name Tipo Description Required Default
chave cadeia Yes
key_id cadeia Yes
tipo enumeração
Valores possíveis: key_and_key_id		 Yes

AzureChatDataSourceModelIdVectorizationSource

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

Name Tipo Description Required Default
model_id cadeia A ID de build do modelo de inserção a ser usada para vetorização. Yes
tipo enumeração O identificador de tipo, sempre 'model_id' para esse tipo de origem 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
Values azure_search
azure_cosmos_db
elasticsearch
pinecone
mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

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

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name Tipo Description Required Default
senha cadeia Yes
tipo enumeração
Valores possíveis: username_and_password		 Yes
nome de usuário cadeia Yes

AzureChatDataSourceVectorizationSource

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

Discriminador para AzureChatDataSourceVectorizationSource

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

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

AzureChatDataSourceVectorizationSourceType

Property Value
Type cadeia
Values endpoint
deployment_name
model_id
integrated

AzureChatMessageContext

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

Name Tipo Description Required Default
all_retrieved_documents objeto Informações resumidas sobre documentos recuperados pela operação de recuperação de dados. No
└─ chunk_id cadeia A ID da parte da citação. No
└─ content cadeia O conteúdo da citação. No
└─ data_source_index inteiro O índice da fonte de dados usada para recuperação. No
└─ filepath cadeia O caminho do arquivo para a citação. No
└─ filter_reason enumeração Se aplicável, uma indicação de por que o documento foi filtrado.
Valores possíveis: score, rerank		 No
└─ original_search_score number A pontuação de pesquisa original para a recuperação. No
└─ rerank_score number A pontuação de reclassificado para a recuperação. No
└─ search_queries matriz As consultas de pesquisa executadas para recuperar documentos. No
└─ title cadeia O título da citação. No
└─ url cadeia A URL da citação. No
citations matriz As citações produzidas pela recuperação de dados. No
intenção cadeia A intenção detectada do histórico de chat, que é usado para levar o contexto da conversa entre interações No

AzureContentFilterBlocklistResult

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

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

AzureContentFilterCompletionTextSpan

Uma representação de um intervalo de texto de conclusão, conforme usado por Azure resultados do filtro de conteúdo openai.

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

AzureContentFilterCompletionTextSpanDetectionResult

Name Tipo Description Required Default
details matriz Informações detalhadas sobre os intervalos de texto de conclusão detectados. Yes
detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes

AzureContentFilterCustomTopicResult

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

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

AzureContentFilterDetectionResult

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

Name Tipo Description Required Default
detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. Yes
filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. Yes

AzureContentFilterImagePromptResults

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

Name Tipo Description Required Default
custom_blocklists objeto Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas. No
└─ details matriz Os pares de IDs individuais da lista de bloqueios e se resultaram em uma ação de filtragem. No
└─ filtered boolean Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem. No
custom_topics objeto Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados. No
└─ details matriz Os pares de IDs de tópico individuais e se são detectados. No
└─ filtered boolean Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. No
jailbreak objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. Yes
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
profanity objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma 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 objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
self_harm objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
sexual objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
violence objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No

AzureContentFilterResultForChoice

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

Name Tipo Description Required Default
custom_blocklists objeto Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas. No
└─ details matriz Os pares de IDs individuais da lista de bloqueios e se resultaram em uma ação de filtragem. No
└─ filtered boolean Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem. No
custom_topics objeto Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados. No
└─ details matriz Os pares de IDs de tópico individuais e se são detectados. No
└─ filtered boolean Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. No
erro objeto Se estiver presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação. No
└─ code inteiro Um código distinto e legível pelo computador associado ao erro. No
└─ message cadeia Uma mensagem legível por humanos associada ao erro. No
hate objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
profanity objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
protected_material_code objeto Um resultado de detecção que descreve uma correspondência com o código licenciado ou outro material de origem protegido. No
└─ citation objeto Se disponível, os detalhes da citação que descrevem a licença associada e sua localização. No
└─ URL cadeia A URL associada à licença. No
└─ license cadeia O nome ou identificador da licença associada à detecção. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
protected_material_text objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
self_harm objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
sexual objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
violence objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No

AzureContentFilterResultForPrompt

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

Name Tipo Description Required Default
content_filter_results objeto Os detalhes da categoria de filtro de conteúdo para o resultado. No
└─ custom_blocklists objeto Uma coleção de resultados de filtragem true/false para listas de bloqueio personalizadas configuradas. No
└─ details matriz Os pares de IDs individuais da lista de bloqueios e se resultaram em uma ação de filtragem. No
└─ filtered boolean Um valor que indica se qualquer uma das listas de bloqueio detalhadas resultou em uma ação de filtragem. No
└─ custom_topics objeto Uma coleção de resultados de filtragem true/false para tópicos personalizados configurados. No
└─ details matriz Os pares de IDs de tópico individuais e se são detectados. No
└─ filtered boolean Um valor que indica se algum dos tópicos detalhados resultou em uma ação de filtragem. No
└─ error objeto Se estiver presente, detalhes sobre um erro que impediu a filtragem de conteúdo de concluir sua avaliação. No
└─ code inteiro Um código distinto e legível pelo computador associado ao erro. No
└─ message cadeia Uma mensagem legível por humanos associada ao erro. No
└─ hate objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
└─ indirect_attack objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ jailbreak objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ profanity objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi detectado e se o conteúdo foi filtrado. No
└─ detected boolean Se a categoria de conteúdo rotulado foi detectada no conteúdo. No
└─ filtered boolean Se a detecção de conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ self_harm objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
└─ sexual objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
└─ violence objeto Um item de resultado de filtro de conteúdo rotulado que indica se o conteúdo foi filtrado e qual foi o nível de severidade qualitativa do conteúdo, conforme avaliado em relação à configuração do filtro de conteúdo para a categoria. No
└─ filtered boolean Se a gravidade do conteúdo resultou em uma ação de filtragem de conteúdo. No
└─ severity enumeração A gravidade rotulada do conteúdo.
Valores possíveis: safe, , low, mediumhigh		 No
prompt_index inteiro O índice do prompt de entrada associado às categorias de resultado do filtro de conteúdo que acompanham. No

AzureContentFilterSeverityResult

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

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

AzureCosmosDBChatDataSource

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

Name Tipo Description Required Default
parameters objeto As informações de parâmetro para controlar o uso da fonte de dados Azure CosmosDB. Yes
└─ allow_partial_result boolean Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falharem. Se não for especificada ou especificada como false, a solicitação falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication AzureChatDataSourceConnectionStringAuthenticationOptions No
└─ container_name cadeia No
└─ database_name cadeia No
└─ embedding_dependency AzureChatDataSourceVectorizationSource Uma representação de uma fonte de vetorização de dados utilizável como um recurso de inserção com uma fonte de dados. No
└─ fields_mapping objeto No
└─ content_fields matriz No
└─ content_fields_separator cadeia No
└─ filepath_field cadeia No
└─ title_field cadeia No
└─ url_field cadeia No
└─ vector_fields matriz No
└─ in_scope boolean Se as consultas devem ser restritas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades de contexto de saída a serem incluídas na resposta.
Por padrão, as citações e a intenção serão solicitadas.		 No ['citations', 'intent']
└─ index_name cadeia No
└─ max_search_queries inteiro O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário.
Por padrão, o sistema fará uma determinação automática.		 No
└─ strictness inteiro A rigidez configurada da filtragem de relevância da pesquisa.
A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.		 No
└─ top_n_documents inteiro O número configurado de documentos a serem apresentados 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 solicitação estendida para conclusões de chat no serviço Azure OpenAI. Isso adiciona a capacidade de fornecer fontes de dados para o recurso On Your Data.

Name Tipo Description Required Default
audio objeto Parâmetros para saída de áudio. Necessá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 de wav, mp3, flac, opusou pcm16.
Valores possíveis: wav, , aac, mp3, flac, , opuspcm16		 No
└─ voice objeto No
data_sources matriz As fontes de dados a serem usadas para o recurso On Your Data, exclusivo para Azure OpenAI. No
frequency_penalty number Número entre -2.0 e 2.0. Valores positivos penalizam novos tokens com base em sua frequência existente no texto até agora, diminuindo a probabilidade do modelo repetir a mesma linha verbatim. No 0
function_call enumeração Especificar uma função específica por meio {"name": "my_function"} de força o modelo a chamar essa função.
Valores possíveis: none, auto		 No
functions matriz Preterido em favor de tools.

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

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

Esse valor agora foi preterido em favor de max_completion_tokens, e não é compatível com modelos da série o1.		 No
messages matriz Uma lista de mensagens que compõem a conversa até agora. Dependendo do modelo usado, há suporte para diferentes tipos de mensagens (modalidades), como texto, imagens e áudio. Yes
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

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

["text"]

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

["text", "audio"]		 No
modelo cadeia O identificador de implantação de modelo a ser usado para a solicitação de conclusão do chat. Yes
n inteiro Quantas opções de conclusão de chat serão geradas para cada mensagem de entrada. Observe que você será cobrado com base no número de tokens gerados em todas as opções. Mantenha n como 1 minimizar os custos. No 1
parallel_tool_calls objeto Se deseja habilitar a chamada de função paralela durante o uso da ferramenta. No
previsão objeto Representação base da saída prevista 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 se eles aparecem no texto até agora, aumentando a probabilidade do modelo falar sobre novos tópicos. No 0
reasoning_effort objeto somente modelos da série o

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
response_format objeto No
└─ type enumeração
Valores possíveis: text, , json_objectjson_schema		 No
seed inteiro Esse recurso está em Beta.
Se especificado, nosso sistema fará o melhor esforço para amostrar deterministicamente, de modo que solicitações repetidas com o mesmo seed e parâmetros devem retornar o mesmo resultado.
O determinismo não é garantido e você deve se referir ao system_fingerprint parâmetro de resposta para monitorar as alterações no back-end.		 No
stop objeto Não há suporte para modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências em que a API deixará de gerar tokens adicionais. O texto retornado não conterá a sequência de interrupção.		 No
armazenar boolean Se deseja ou não armazenar a saída dessa solicitação de conclusão de chat para uso em produtos de destilação de modelo ou de avaliação. No False
fluxo boolean Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. No False
stream_options objeto Opções para resposta de streaming. Defina isso somente quando você definir stream: true. No
└─ include_usage boolean Se definido, uma parte adicional será transmitida antes da data: [DONE] mensagem. O usage campo nessa parte mostra as estatísticas de uso do token para toda a solicitação e o choices campo sempre será uma matriz vazia.

Todas as outras partes também incluirão um usage campo, mas com um valor nulo. NOTA: Se o fluxo for interrompido, você poderá não receber a parte de uso final que contém o uso total do token para a solicitação.		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No 1
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla qual ferramenta (se houver) é chamada pelo modelo.
none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.
auto significa que o modelo pode escolher entre gerar uma mensagem ou chamar uma ou mais ferramentas.
required significa que o modelo deve chamar uma ou mais ferramentas.
Especificar uma ferramenta específica por meio {"type": "function", "function": {"name": "my_function"}} de força o modelo a chamar essa ferramenta.

none é o padrão quando nenhuma ferramenta está presente. auto é o padrão se as ferramentas estiverem presentes.		 No
tools matriz Uma lista de ferramentas que o modelo pode chamar. Atualmente, há suporte apenas para funções como uma ferramenta. Use isso para fornecer uma lista de funções para as quais o modelo pode gerar entradas JSON. Há suporte para um máximo de 128 funções. No
top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No 1
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar a monitorar e detectar abusos. No
user_security_context AzureUserSecurityContext O contexto de segurança do usuário contém vários parâmetros que descrevem o próprio aplicativo e o usuário final que interage com o aplicativo. Esses campos ajudam suas equipes de operações de segurança a investigar e mitigar incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Learn mais sobre como proteger aplicativos de IA usando Microsoft Defender para Nuvem. No

AzureCreateChatCompletionResponse

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

Name Tipo Description Required Default
choices matriz Yes
created inteiro O carimbo de data/hora unix (em segundos) de quando a conclusão do chat foi criada. Yes
id cadeia Um identificador exclusivo para a conclusão do chat. Yes
modelo cadeia O modelo usado para a conclusão do chat. Yes
objeto enumeração O tipo de objeto, que é sempre chat.completion.
Valores possíveis: chat.completion		 Yes
prompt_filter_results matriz As anotações de filtro de conteúdo de IA responsável associadas a entradas de prompt em conclusões de chat. No
system_fingerprint cadeia Essa impressão digital representa a configuração de back-end com a qual o modelo é executado.

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

AzureCreateChatCompletionStreamResponse

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

AzureCreateEmbeddingRequest

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

AzureCreateFileRequestMultiPart

Name Tipo Description Required Default
expires_after objeto Yes
└─ anchor AzureFileExpiryAnchor No
└─ seconds inteiro No
arquivo cadeia Yes
purpose enumeração A finalidade pretendida do arquivo carregado. Um deles: : assistantsUsado na API de Assistentes – batch: Usado na API do Lote – fine-tune: Usado para ajuste fino – evals: usado para conjuntos de dados de avaliação.
Valores possíveis: assistants, , batch, fine-tuneevals		 Yes

AzureCreateImageEditRequestMultiPart

Name Tipo Description Required Default
em segundo plano enumeração Permite definir a transparência para a tela de fundo das imagens geradas.
Esse parâmetro só tem suporte para gpt-image-1 modelos. Deve ser um ou transparentopaqueauto (valor padrão). Quando auto for usado, o modelo determinará automaticamente o melhor plano de fundo para a imagem.

Se transparent, o formato de saída precisa dar suporte à transparência, portanto, ele deve ser definido como png (valor padrão) ou webp.
Valores possíveis: transparent, , opaqueauto		 No
imagem cadeia de caracteres ou matriz Yes
máscara cadeia No
modelo cadeia A implantação de modelo a ser usada para a operação de edição de imagem. Yes
n inteiro O número de imagens a serem geradas. Deve estar entre 1 e 10. No 1
output_compression inteiro O nível de compactação (0-100%) para as imagens geradas. Esse parâmetro só tem suporte para gpt-image-1modelos de série com os webp formatos ou jpeg saída e usa como padrão 100. No 100
output_format enumeração O formato no qual as imagens geradas são retornadas. Esse parâmetro só tem suporte para gpt-image-1modelos de série. Deve ser um de png, jpegou webp.
O valor padrão é png.
Valores possíveis: png, , jpegwebp		 No
solicitação cadeia Uma descrição de texto das imagens desejadas. O comprimento máximo é de 1.000 caracteres e dall-e-23.2000 caracteres para gpt-image-1modelos da série. Yes
quality enumeração A qualidade da imagem que será gerada. high, medium e low só têm suporte para gpt-image-1modelos de série. dall-e-2 só dá suporte à standard qualidade. O padrão é auto.
Valores possíveis: standard, , low, medium, high, auto		 No
response_format enumeração O formato no qual as imagens geradas são retornadas. Deve ser um de url ou b64_json. As URLs só são válidas por 60 minutos após a geração da imagem. Esse parâmetro só tem suporte para dall-e-2modelos de série, pois gpt-image-1os modelos de série sempre retornarão imagens codificadas em 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 de série e um de 256x256, 512x512ou 1024x1024 para dall-e-2.
Valores possíveis: 256x256, , 512x512, 1024x1024, 1536x1024, , 1024x1536auto		 No
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No

AzureCreateImageRequest

Name Tipo Description Required Default
em segundo plano enumeração Permite definir a transparência para a tela de fundo das imagens geradas.
Esse parâmetro só tem suporte para gpt-image-1 modelos. Deve ser um ou transparentopaqueauto (valor padrão). Quando auto for usado, o modelo determinará automaticamente o melhor plano de fundo para a imagem.

Se transparent, o formato de saída precisa dar suporte à transparência, portanto, ele deve ser definido como png (valor padrão) ou webp.
Valores possíveis: transparent, , opaqueauto		 No
modelo cadeia A implantação de modelo a ser usada para a geração de imagem. Yes
moderation enumeração Controlar o nível de moderação de conteúdo para imagens geradas por gpt-image-1modelos de série. Deve ser low para filtragem menos restritiva ou auto (valor padrão).
Valores possíveis: low, auto		 No
n inteiro O número de imagens a serem geradas. Deve estar entre 1 e 10. Para dall-e-3, só n=1 há suporte. No 1
output_compression inteiro O nível de compactação (0-100%) para as imagens geradas. Esse parâmetro só tem suporte para gpt-image-1modelos de série com os webp formatos ou jpeg saída e usa como padrão 100. No 100
output_format enumeração O formato no qual as imagens geradas são retornadas. Esse parâmetro só tem suporte para gpt-image-1modelos de série. Deve ser um de png, jpegou webp.
Valores possíveis: png, , jpegwebp		 No
solicitação cadeia Uma descrição de texto das imagens desejadas. Yes
quality enumeração A qualidade da imagem que será gerada.

- auto (valor padrão) selecionará automaticamente a melhor qualidade para o modelo fornecido.
- high medium e low são compatíveis com gpt-image-1modelos de série.
- hd e standard têm suporte para dall-e-3.
- standard é a única opção para dall-e-2.
Valores possíveis: standard, , hd, low, medium, , highauto		 No
response_format enumeração O formato no qual as imagens geradas são dall-e-2 retornadas e dall-e-3 retornadas. Deve ser um de url ou b64_json. As URLs só são válidas por 60 minutos após a geração da imagem. Esse parâmetro não tem suporte para gpt-image-1modelos de série que sempre retornarão imagens codificadas em 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 de série, um de 256x256, 512x512ou 1024x1024 para dall-e-2, e um de 1024x1024, 1792x1024ou 1024x1792 para dall-e-3.
Valores possíveis: auto, , 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, , , 1792x10241024x1792		 No
estilo enumeração O estilo das imagens geradas. Esse parâmetro só tem suporte para dall-e-3. Deve ser um de vivid ou natural. O Vivid 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 e menos hiper-reais.
Valores possíveis: vivid, natural		 No
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No

AzureCreateResponse

Name Tipo Description Required Default
em segundo plano boolean Se a resposta do modelo deve ser executada em segundo plano. No False
include matriz Especifique dados de saída adicionais a serem incluídos na resposta do modelo. Os valores com suporte no momento são:
- code_interpreter_call.outputs: inclui as saídas da execução de código python em itens de chamada de ferramenta de interpretador de código.
- computer_call_output.output.image_url: inclua urls de imagem da saída da chamada do computador.
- file_search_call.results: inclua os resultados da pesquisa da chamada da ferramenta de pesquisa de arquivos.
- message.input_image.image_url: inclua urls de imagem da mensagem de entrada.
- message.output_text.logprobs: inclua logprobs com mensagens de assistente.
- reasoning.encrypted_content: inclui uma versão criptografada de tokens de raciocínio em saídas de itens de raciocínio. Isso permite que os itens de raciocínio sejam usados em conversas de vários turnos ao usar a API de Respostas sem estado (como quando o store parâmetro é definido falsecomo , ou quando uma organização é registrada no programa de retenção de dados zero).		 No
entrada cadeia de caracteres ou matriz No
instructions cadeia Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
modelo cadeia A implantação do modelo a ser usada para a criação dessa resposta. Yes
parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
solicitação objeto Referência a um modelo de prompt e suas variáveis. No
└─ id cadeia O identificador exclusivo do modelo de prompt a ser usado. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. No
└─ version cadeia Versão opcional do modelo de prompt. No
reasoning objeto somente modelos da série o

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

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
└─ generate_summary enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
└─ summary enumeração Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
armazenar boolean Se deseja armazenar a resposta do modelo gerado para recuperação posterior por meio da API. No True
fluxo boolean Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem 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, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No 1
enviar SMS objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objeto Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

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

required significa que o modelo deve chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. No
tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo, como a pesquisa de arquivos.
- Chamadas de função (ferramentas personalizadas): Funções definidas por você, permitindo que o modelo chame seu próprio código.		 No
top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

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

AzureCreateSpeechRequestMultiPart

Uma representação das opções de solicitação que controlam o comportamento de uma operação de conversão de texto em fala.

Name Tipo Description Required Default
entrada cadeia O texto para o qual gerar áudio. O comprimento máximo é de 4.096 caracteres. Yes
instructions cadeia Controle a voz do áudio gerado com instruções adicionais. Não funciona com tts-1 ou tts-1-hd. No
modelo cadeia O modelo a ser usado para essa solicitação de conversão de texto em fala. Yes
response_format objeto Os formatos de saída de áudio com suporte para conversão de texto em fala. No
speed number A velocidade da fala do áudio gerado. Os valores são válidos no intervalo de 0,25 a 4,0, com 1,0 os valores padrão e mais altos correspondentes à fala mais rápida. No 1
stream_format enumeração O formato para transmitir o áudio. Os formatos com suporte são sse e audio. sse não há suporte para tts-1 ou tts-1-hd.
Valores possíveis: sse, audio		 No
voice objeto Yes

AzureCreateTranscriptionRequestMultiPart

As informações de configuração de uma solicitação de transcrição de áudio.

Name Tipo Description Required Default
chunking_strategy objeto No
└─ prefix_padding_ms inteiro Quantidade de áudio a ser incluída antes da fala detectada pelo VAD (em milissegundos). No 300
└─ silence_duration_ms inteiro Duração do silêncio para detectar a parada de fala (em milissegundos).
Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do usuário.		 No 200
└─ threshold number Limite de confidencialidade (0,0 a 1,0) para detecção de atividade de voz. Um limite mais alto exigirá um áudio mais alto para ativar o modelo e, portanto, poderá ter um desempenho melhor em ambientes barulhentos. No 0.5
└─ type enumeração Deve ser definido para server_vad habilitar o agrupamento manual usando o VAD do lado do servidor.
Valores possíveis: server_vad		 No
arquivo cadeia Yes
filename cadeia O nome de arquivo opcional ou o identificador descritivo a ser associado aos dados de áudio. No
include[] matriz Informações adicionais a serem incluídas na resposta de transcrição.
logprobs retornará as probabilidades de log dos tokens na resposta para entender a confiança do modelo na transcrição.
logprobssó funciona com response_format definidos json como e somente com os modelosgpt-4o-transcribe, gpt-4o-transcribe-diarizee gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15.		 No
linguagem cadeia O idioma do áudio de entrada. Fornecer o idioma de entrada no formato ISO-639-1 (por exemplo en) melhorará a precisão e a latência. No
modelo cadeia O modelo a ser usado para essa solicitação de transcrição. No
solicitação cadeia Um texto opcional para orientar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve corresponder ao idioma de áudio. No
response_format objeto No
fluxo boolean Se definido como true, os dados de resposta do modelo serão transmitidos para o cliente à medida que forem gerados usando eventos enviados pelo servidor. Observação: o streaming não tem suporte 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, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico. Se definido como 0, o modelo usará a probabilidade de log para aumentar automaticamente a temperatura até que determinados limites sejam atingidos. No 0
timestamp_granularities[] matriz As granularidades de carimbo de data/hora a serem preenchidas para essa transcrição. response_format deve ser definido verbose_json para usar granularidades de carimbo de data/hora. Há suporte para ambas ou ambas as opções: wordou segment. Observação: não há latência adicional para carimbos de data/hora do segmento, mas gerar carimbos de data/hora de palavra incorre em latência adicional. No ['segment']

AzureCreateTranslationRequestMultiPart

As informações de configuração de uma solicitação de transcrição de áudio.

Name Tipo Description Required Default
arquivo cadeia Yes
filename cadeia O nome de arquivo opcional ou o identificador descritivo a ser associado aos dados de áudio No
modelo cadeia O modelo a ser usado para essa solicitação de tradução. No
solicitação cadeia Um texto opcional para orientar o estilo do modelo ou continuar um segmento de áudio anterior. O prompt deve estar em inglês. No
response_format objeto No
temperature number A temperatura de amostragem, entre 0 e 1. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico. Se definido como 0, o modelo usará a probabilidade de log para aumentar automaticamente a temperatura até que determinados limites sejam atingidos. No 0

AzureErrorResponse

Name Tipo Description Required Default
erro objeto Os detalhes do erro. No
└─ code cadeia O identificador distinto gerado pelo computador para o erro. No
└─ inner_error No
└─ message cadeia Uma mensagem legível por humanos associada ao erro. No
└─ param cadeia Se aplicável, o parâmetro de entrada de solicitação associado ao erro No
└─ type enumeração O tipo de objeto, sempre "error".
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 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, , mediumhigh		 No
seed inteiro Um valor de 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úcleo; 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
Values created_at

AzureFineTuneReinforcementMethod

Name Tipo Description Required Default
grader objeto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. No
└─ evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 No
└─ graders objeto No
└─ input matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. No
└─ model cadeia O modelo a ser usado para a avaliação. No
└─ name cadeia O nome do classificador. No
└─ operation enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 No
└─ range matriz O intervalo da pontuação. O padrão é [0, 1]. No
└─ reference cadeia O texto que está sendo classificado. No
└─ sampling_params Os parâmetros de amostragem do 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 objeto No
└─ json_schema objeto 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 O JSON codificado em base64 da imagem gerada. Valor padrão para gpt-image-1modelos de série e presente somente 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 do filtro de conteúdo para o conteúdo da solicitação de entrada de uma operação de geração de imagem. Yes
revised_prompt cadeia Somente dall-e-3 para o prompt revisado que foi usado para gerar a imagem. No
url cadeia Ao usar dall-e-2 ou dall-e-3, a URL da imagem gerada se response_format estiver definida como url (valor padrão). Sem suporte para gpt-image-1modelos de série. No

AzureImagesResponse

Name Tipo Description Required Default
em segundo plano enumeração Somente GPT-image-1: o parâmetro de plano de fundo usado para a geração de imagem. Ou transparent .opaque
Valores possíveis: transparent, opaque		 No
created inteiro O carimbo de data/hora 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 de imagem. Ou png, webpou jpeg.
Valores possíveis: png, , webpjpeg		 No
quality enumeração A qualidade da imagem gerada. Ou low, mediumou high.
Valores possíveis: low, , mediumhigh		 No
size enumeração O tamanho da imagem gerada. Ou 1024x1024, 1024x1536ou 1536x1024.
Valores possíveis: 1024x1024, , 1024x15361536x1024		 No
uso objeto Somente para gpt-image-1modelos de série, as informações de uso do token para a geração de imagem. No
└─ input_tokens inteiro O número de tokens (imagens e texto) no prompt de entrada. No
└─ input_tokens_details objeto As informações detalhadas dos tokens de entrada para a geração de imagem. No
└─ image_tokens inteiro O número de tokens de imagem no prompt de entrada. No
└─ text_tokens inteiro O número de tokens de texto no prompt de entrada. No
└─ output_tokens inteiro O número de tokens de imagem na imagem de saída. No
└─ total_tokens inteiro O número total de tokens (imagens e texto) usados para a geração de imagem. No

AzureListFilesResponse

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia Yes
has_more boolean Yes
last_id cadeia Yes
objeto enumeração
Valores possíveis: list		 Yes

AzureOpenAIFile

Name Tipo Description Required Default
bytes inteiro O tamanho do arquivo, em bytes. Yes
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando o arquivo foi criado. Yes
expires_at inteiro O carimbo de data/hora unix (em segundos) para quando o arquivo expirará. No
filename cadeia O nome do arquivo. Yes
id cadeia O identificador de arquivo, que pode ser referenciado nos pontos de extremidade da API. Yes
objeto enumeração O tipo de objeto, que é sempre file.
Valores possíveis: file		 Yes
purpose enumeração A finalidade pretendida do arquivo. Os valores com suporte sãoassistants, , assistants_output, batche batch_outputfine-tunefine-tune-results.
Valores possíveis: assistants, , assistants_output, batch, batch_output, fine-tune, , fine-tune-results, evals		 Yes
status enumeração
Valores possíveis: uploaded, , pending, running, processed, error, , deleting, deleted		 Yes
status_details cadeia Deprecated. Para obter detalhes sobre por que um arquivo de treinamento de ajuste fino falhou na validação, consulte o error campo em fine_tuning.job. No

AzureOpenAIVideoGenerationErrorResponse

Name Tipo Description Required Default
codificar cadeia O identificador distinto gerado pelo computador para o erro. No
inner_error objeto Se aplicável, um erro upstream que originou esse erro. No
└─ code enumeração O código associado ao erro interno.
Valores possíveis: ResponsibleAIPolicyViolation		 No
└─ error_details Os detalhes do resultado do filtro de conteúdo associados ao erro interno. No
└─ revised_prompt cadeia Se aplicável, o prompt modificado usado para geração. No
mensagem cadeia Uma mensagem legível por humanos associada ao erro. No
param cadeia Se aplicável, o parâmetro de entrada de solicitação associado ao erro No
tipo cadeia 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 a resposta do modelo deve ser executada em segundo plano. No False
created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. Yes
erro objeto Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. Yes
└─ code OpenAI.ResponseErrorCode O código de erro da resposta. No
└─ message cadeia Uma descrição legível pelo humano do erro. No
id cadeia Identificador exclusivo para esta resposta. Yes
incomplete_details objeto Detalhes sobre por que a resposta está incompleta. Yes
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
instructions cadeia de caracteres ou matriz Yes
max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
modelo cadeia O modelo usado para gerar essa resposta. Yes
objeto enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 Yes
saída matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 Yes
output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. Yes True
previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
solicitação objeto Referência a um modelo de prompt e suas variáveis. No
└─ id cadeia O identificador exclusivo do modelo de prompt a ser usado. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. No
└─ version cadeia Versão opcional do modelo de prompt. No
reasoning objeto somente modelos da série o

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

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
└─ generate_summary enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
└─ summary enumeração Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 Yes
enviar SMS objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objeto Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

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

required significa que o modelo deve chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. No
tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 Yes
truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
uso OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. Yes

AzureSearchChatDataSource

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

Name Tipo Description Required Default
parameters objeto As informações de parâmetro para controlar o uso da fonte de dados Azure Pesquisa. Yes
└─ allow_partial_result boolean Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falharem. Se não for especificada ou especificada como false, a solicitação falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication objeto No
└─ access_token cadeia No
└─ key cadeia No
└─ managed_identity_resource_id cadeia No
└─ type enumeração
Valores possíveis: access_token		 No
└─ embedding_dependency objeto Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de inserção Azure OpenAI. No
└─ authentication AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions O mecanismo de autenticação a ser usado com a origem de vetorização baseada em ponto de extremidade.
A autenticação de ponto de extremidade dá suporte a mecanismos de token de acesso e chave de API.		 No
└─ deployment_name cadeia A implantação do modelo de inserção a ser usada para vetorização. Essa implantação deve existir no mesmo Azure recurso OpenAI que a implantação de modelo que está sendo usada para conclusões de chat. No
└─ dimensions inteiro O número de dimensões a serem solicitadas em inserções.
Só há suporte em modelos "text-embedding-3" e posteriores.		 No
└─ endpoint cadeia Especifica a URL do ponto de extremidade de recurso da qual as inserções devem ser recuperadas.
Ele deve estar no formato de:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
O parâmetro de consulta de versão de api não é permitido.		 No
└─ type enumeração O identificador de tipo, sempre 'integrado' para esse tipo de origem de vetorização.
Valores possíveis: integrated		 No
└─ endpoint cadeia O caminho de ponto de extremidade absoluto para o recurso Azure Search a ser usado. No
└─ fields_mapping objeto Os mapeamentos de campo a serem usados 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 O padrão separador que os campos de conteúdo devem usar. No
└─ filepath_field cadeia O nome do campo de índice a ser usado como um caminho de arquivo. No
└─ image_vector_fields matriz Os nomes dos campos que representam dados de vetor de imagem. No
└─ title_field cadeia O nome do campo de índice a ser usado como um título. No
└─ url_field cadeia O nome do campo de índice a ser usado como UMA URL. No
└─ vector_fields matriz Os nomes dos campos que representam dados de vetor. No
└─ filter cadeia Um filtro a ser aplicado à pesquisa. No
└─ in_scope boolean Se as consultas devem ser restritas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades de contexto de saída a serem incluídas na resposta.
Por padrão, as citações e a intenção serão solicitadas.		 No ['citations', 'intent']
└─ index_name cadeia O nome do índice a ser usado, conforme especificado no recurso Azure Search. No
└─ max_search_queries inteiro O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário.
Por padrão, o sistema fará uma determinação automática.		 No
└─ query_type enumeração O tipo de consulta para o recurso Azure Search a ser usado.
Valores possíveis: simple, , semantic, vector, vector_simple_hybrid, vector_semantic_hybrid		 No
└─ semantic_configuration cadeia Configuração semântica adicional para a consulta. No
└─ strictness inteiro A rigidez configurada da filtragem de relevância da pesquisa.
A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.		 No
└─ top_n_documents inteiro O número configurado de documentos a serem apresentados 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 usuário contém vários parâmetros que descrevem o próprio aplicativo e o usuário final que interage com o aplicativo. Esses campos ajudam suas equipes de operações de segurança a investigar e mitigar incidentes de segurança fornecendo uma abordagem abrangente para proteger seus aplicativos de IA. Learn mais sobre como proteger aplicativos de IA usando Microsoft Defender para Nuvem.

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

ChatCompletionMessageToolCallsItem

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

Matriz de: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name Tipo Description Required Default
height inteiro A altura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes
modelo cadeia O nome da implantação a ser usada para essa solicitação. Yes
n_seconds inteiro A duração do trabalho de geração de vídeo. Deve estar entre 1 e 20 segundos. No 5
n_variants inteiro O número de vídeos a serem criados como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
solicitação cadeia O prompt para este trabalho de geração de vídeo. Yes
width inteiro A largura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes

CreateVideoGenerationWithMediaRequestMultiPart

As propriedades de uma solicitação de trabalho de geração de vídeo com arquivos de mídia.

Name Tipo Description Required Default
files matriz Yes
height inteiro A altura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes
inpaint_items matriz Itens de insintação opcionais para este trabalho de geração de vídeo. No
modelo cadeia O nome da implantação a ser usada para essa solicitação. Yes
n_seconds inteiro A duração do trabalho de geração de vídeo. Deve estar entre 1 e 20 segundos. No 5
n_variants inteiro O número de vídeos a serem criados como variantes para este trabalho. Deve estar entre 1 e 5. Dimensões menores permitem mais variantes. No 1
solicitação cadeia O prompt para este trabalho de geração de vídeo. Yes
width inteiro A largura do vídeo. Há suporte para as seguintes dimensões: 480x480, 854x480, 720x720, 1280x720, 1080x1080 e 1920x1080 nas orientações paisagem e retrato. Yes

CropBounds

Os limites de corte para um item de encanamento. Isso especifica a área do item de mídia que deve ser usada para a insintação.

Name Tipo Description Required Default
bottom_fraction number O limite inferior da caixa de corte especificada como fração da altura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do item de mídia original. No 1
left_fraction number O limite esquerdo da caixa de corte especificada como fração da largura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do item de mídia original. No 0
right_fraction number O limite direito da caixa de corte especificada como fração da largura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do item de mídia original. No 1
top_fraction number O limite superior da caixa de corte especificada como fração da altura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do item de mídia original. No 0

ElasticsearchChatDataSource

Name Tipo Description Required Default
parameters objeto As informações de parâmetro para controlar o uso da fonte de dados Elasticsearch. Yes
└─ allow_partial_result boolean Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falharem. Se não for especificada ou especificada como false, a solicitação falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication objeto No
└─ encoded_api_key cadeia No
└─ key cadeia No
└─ key_id cadeia 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 um recurso de inserção com uma fonte de dados. No
└─ endpoint cadeia No
└─ fields_mapping objeto No
└─ content_fields matriz No
└─ content_fields_separator cadeia No
└─ filepath_field cadeia No
└─ title_field cadeia No
└─ url_field cadeia No
└─ vector_fields matriz No
└─ in_scope boolean Se as consultas devem ser restritas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades de contexto de saída a serem incluídas na resposta.
Por padrão, as citações e a intenção serão solicitadas.		 No ['citations', 'intent']
└─ index_name cadeia No
└─ max_search_queries inteiro O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário.
Por padrão, o sistema fará uma determinação automática.		 No
└─ query_type enumeração
Valores possíveis: simple, vector		 No
└─ strictness inteiro A rigidez configurada da filtragem de relevância da pesquisa.
A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.		 No
└─ top_n_documents inteiro O número configurado de documentos a serem apresentados na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre 'elasticsearch'.
Valores possíveis: elasticsearch		 Yes

InpaintItem

Um item de insintação para um trabalho de geração de vídeo. Isso especifica o item de mídia que deve ser usado para a insintação na geração de vídeo.

Name Tipo Description Required Default
crop_bounds objeto Os limites de corte para um item de encanamento.
Isso especifica a área do item de mídia que deve ser usada para a insintação.		 No
└─ bottom_fraction number O limite inferior da caixa de corte especificada como fração da altura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do item de mídia original. No 1
└─ left_fraction number O limite esquerdo da caixa de corte especificada como fração da largura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do item de mídia original. No 0
└─ right_fraction number O limite direito da caixa de corte especificada como fração da largura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da largura do item de mídia original. No 1
└─ top_fraction number O limite superior da caixa de corte especificada como fração da altura do item de mídia original. Deve estar entre 0,0 e 1,0. Use, por exemplo, 0,5 para metade da altura do item de mídia original. No 0
file_name cadeia O nome do arquivo do item de mídia. Ele deve corresponder ao nome do arquivo de um anexo de arquivo nesta solicitação. Yes
frame_index inteiro O índice de quadros para este item de mídia. Isso especifica o quadro inicial no vídeo gerado resultante para este item de insintação. Yes 0
tipo objeto O tipo do item de insintação. Yes

JobStatus

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

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

MediaItemType

O tipo do item de insintação.

Property Value
Description O tipo do item de insintação.
Type cadeia
Values image

MongoDBChatDataSource

Name Tipo Description Required Default
parameters objeto As informações de parâmetro para controlar o uso da fonte de dados do MongoDB. Yes
└─ allow_partial_result boolean Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falharem. Se não for especificada ou especificada como false, a solicitação falhará se qualquer consulta de pesquisa falhar. No False
└─ app_name cadeia O nome do aplicativo MongoDB. No
└─ authentication objeto No
└─ password cadeia No
└─ type enumeração
Valores possíveis: username_and_password		 No
└─ username cadeia No
└─ collection_name cadeia O nome da coleção MongoDB. No
└─ database_name cadeia O nome do banco de dados do MongoDB. No
└─ embedding_dependency objeto Representa uma fonte de vetorização que faz chamadas de serviço público em uma implantação de modelo de inserção Azure OpenAI. No
└─ authentication AzureChatDataSourceApiKeyAuthenticationOptions ou AzureChatDataSourceAccessTokenAuthenticationOptions O mecanismo de autenticação a ser usado com a origem de vetorização baseada em ponto de extremidade.
A autenticação de ponto de extremidade dá suporte a mecanismos de token de acesso e chave de API.		 No
└─ deployment_name cadeia A implantação do modelo de inserção a ser usada para vetorização. Essa implantação deve existir no mesmo Azure recurso OpenAI que a implantação de modelo que está sendo usada para conclusões de chat. No
└─ dimensions inteiro O número de dimensões a serem solicitadas em inserções.
Só há suporte em modelos "text-embedding-3" e posteriores.		 No
└─ endpoint cadeia Especifica a URL do ponto de extremidade de recurso da qual as inserções devem ser recuperadas.
Ele deve estar no formato de:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings.
O parâmetro de consulta de versão de api não é permitido.		 No
└─ type enumeração O identificador de tipo, sempre 'deployment_name' para esse tipo de origem de vetorização.
Valores possíveis: deployment_name		 No
└─ endpoint cadeia O nome do ponto de extremidade do cluster do MongoDB. No
└─ fields_mapping objeto Mapeamentos de campo a serem aplicados aos dados usados pela fonte de dados do MongoDB.
Observe que os mapeamentos de conteúdo e de campo de vetor são necessários para o MongoDB.		 No
└─ content_fields matriz No
└─ content_fields_separator cadeia No
└─ filepath_field cadeia No
└─ title_field cadeia No
└─ url_field cadeia No
└─ vector_fields matriz No
└─ in_scope boolean Se as consultas devem ser restritas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades de contexto de saída a serem incluídas na resposta.
Por padrão, as citações e a intenção serão solicitadas.		 No ['citations', 'intent']
└─ index_name cadeia O nome do índice MongoDB. No
└─ max_search_queries inteiro O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário.
Por padrão, o sistema fará uma determinação automática.		 No
└─ strictness inteiro A rigidez configurada da filtragem de relevância da pesquisa.
A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.		 No
└─ top_n_documents inteiro O número configurado de documentos a serem apresentados na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre "mongo_db".
Valores possíveis: mongo_db		 Yes

OpenAI.Annotation

Discriminatório para OpenAI.Annotation

Esse componente usa 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 a um arquivo.

Name Tipo Description Required Default
file_id cadeia A ID do arquivo. Yes
filename cadeia O nome do arquivo citado. Yes
indexar inteiro O índice do arquivo na lista de arquivos. Yes
tipo enumeração O tipo da citação de arquivo. Sempre file_citation.
Valores possíveis: file_citation		 Yes

OpenAI.AnnotationFilePath

Um caminho para um arquivo.

Name Tipo Description Required Default
file_id cadeia A ID do arquivo. Yes
indexar inteiro O índice do arquivo na lista de arquivos. Yes
tipo enumeração O tipo do caminho do arquivo. Sempre file_path.
Valores possíveis: file_path		 Yes

OpenAI.AnnotationType

Property Value
Type cadeia
Values file_citation
url_citation
file_path
container_file_citation

OpenAI.AnnotationUrlCitation

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

Name Tipo Description Required Default
end_index inteiro O índice do último caractere da citação de URL na mensagem. Yes
start_index inteiro O índice do primeiro caractere da citação de URL na mensagem. Yes
title cadeia O título do recurso da Web. Yes
tipo enumeração O tipo da citação de URL. Sempre url_citation.
Valores possíveis: url_citation		 Yes
url cadeia A URL do recurso da Web. Yes

OpenAI.ApproximateLocation

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

OpenAI.AudioResponseFormat

O formato da saída, em uma destas opções: json, , text, srt, ou verbose_jsonvtt. Para gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15. O único formato com suporte é json.

Property Value
Description O formato da saída, em uma destas opções: json, , text, srt, ou verbose_jsonvtt. Para gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribee gpt-4o-mini-transcribe-2025-12-15. O único formato com suporte é json.
Type cadeia
Values json
text
srt
verbose_json
vtt

OpenAI.AutoChunkingStrategyRequestParam

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

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

OpenAI.ChatCompletionFunctionCallOption

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

Name Tipo Description Required Default
name cadeia O nome da função a ser chamada. Yes

OpenAI.ChatCompletionFunctions

Name Tipo Description Required Default
description cadeia Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função. No
name cadeia O nome da função a ser chamada. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
parameters Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON.
Consulte a referência de esquema JSON para obter documentação sobre o formato.

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

OpenAI.ChatCompletionMessageAudioChunk

Name Tipo Description Required Default
dados cadeia No
expires_at inteiro No
id cadeia No
transcrição cadeia No

OpenAI.ChatCompletionMessageToolCall

Name Tipo Description Required Default
função objeto A função chamada pelo modelo. Yes
└─ arguments cadeia Os argumentos com os quais chamar a função, conforme gerado pelo modelo no formato JSON. Observe que o modelo nem sempre gera JSON válido e pode alucinar parâmetros não definidos pelo esquema de função. Valide os argumentos em seu código antes de chamar sua função. No
└─ name cadeia O nome da função a ser chamada. No
id cadeia A ID da chamada da ferramenta. Yes
tipo enumeração O tipo da ferramenta. Atualmente, só function há suporte.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name Tipo Description Required Default
função objeto No
└─ arguments cadeia Os argumentos com os quais chamar a função, conforme gerado pelo modelo no formato JSON. Observe que o modelo nem sempre gera JSON válido e pode alucinar parâmetros não definidos pelo esquema de função. Valide os argumentos em seu código antes de chamar sua função. No
└─ name cadeia O nome da função a ser chamada. No
id cadeia A ID da chamada da ferramenta. No
indexar inteiro Yes
tipo enumeração O tipo da ferramenta. Atualmente, só function há suporte.
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 objeto Yes
└─ name cadeia O nome da função a ser chamada. No
tipo enumeração O tipo da ferramenta. Atualmente, só function há suporte.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionRequestAssistantMessage

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

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

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name Tipo Description Required Default
refusal cadeia A mensagem de recusa gerada pelo modelo. Yes
enviar SMS cadeia O conteúdo do texto. Yes
tipo enumeração O tipo da parte de conteúdo.
Valores possíveis: refusal		 Yes

OpenAI.ChatCompletionRequestDeveloperMessage

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

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

OpenAI.ChatCompletionRequestFunctionMessage

Name Tipo Description Required Default
conteúdo cadeia O conteúdo da mensagem de função. Yes
name cadeia O nome da função a ser chamada. Yes
função enumeração A função do autor das mensagens, nesse caso function.
Valores possíveis: function		 Yes

OpenAI.ChatCompletionRequestMessage

Discriminador para OpenAI.ChatCompletionRequestMessage

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

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 cadeia de caracteres ou matriz No
função objeto A função do autor de uma mensagem Yes

OpenAI.ChatCompletionRequestMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestMessageContentPart

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

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 objeto Yes
└─ data cadeia Dados de áudio codificados em Base64. No
└─ format enumeração O formato dos dados de áudio codificados. Atualmente, dá suporte a "wav" e "mp3".
Valores possíveis: wav, mp3		 No
tipo enumeração O tipo da parte de conteúdo. Sempre input_audio.
Valores possíveis: input_audio		 Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name Tipo Description Required Default
arquivo objeto Yes
└─ file_data cadeia Os dados de arquivo codificados em base64, usados ao passar o arquivo para o modelo como uma cadeia de caracteres. No
└─ file_id cadeia A ID de um arquivo carregado a ser usado como entrada. No
└─ filename cadeia O nome do arquivo, usado ao passar o arquivo para o modelo como uma cadeia de caracteres. No
tipo enumeração O tipo da parte de conteúdo. Sempre file.
Valores possíveis: file		 Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name Tipo Description Required Default
image_url objeto Yes
└─ detail enumeração Especifica o nível de detalhes da imagem.
Valores possíveis: auto, , lowhigh		 No
└─ url cadeia Uma URL da imagem ou os dados de imagem codificados em base64. No
tipo enumeração O tipo da parte de conteúdo.
Valores possíveis: image_url		 Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

Property Value
Type cadeia
Values text
file
input_audio
image_url
refusal

OpenAI.ChatCompletionRequestSystemMessage

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

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

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

OpenAI.ChatCompletionRequestToolMessageContentPart

References: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

Name Tipo Description Required Default
conteúdo cadeia de caracteres ou matriz Yes
name cadeia Um nome opcional para o participante. Fornece as informações de modelo para diferenciar entre os participantes da mesma função. No
função enumeração A função do autor das mensagens, nesse caso user.
Valores possíveis: user		 Yes

OpenAI.ChatCompletionRequestUserMessageContentPart

Name Tipo Description Required Default
arquivo objeto Yes
└─ file_data cadeia Os dados de arquivo codificados em base64, usados ao passar o arquivo para o modelo como uma cadeia de caracteres. No
└─ file_id cadeia A ID de um arquivo carregado a ser usado como entrada. No
└─ filename cadeia O nome do arquivo, usado ao passar o arquivo para o modelo como uma cadeia de caracteres. No
image_url objeto Yes
└─ detail enumeração Especifica o nível de detalhes da imagem.
Valores possíveis: auto, , lowhigh		 No
└─ url cadeia Uma URL da imagem ou os dados de imagem codificados em base64. No
input_audio objeto Yes
└─ data cadeia Dados de áudio codificados em Base64. No
└─ format enumeração O formato dos dados de áudio codificados. Atualmente, dá suporte a "wav" e "mp3".
Valores possíveis: wav, mp3		 No
enviar SMS cadeia O conteúdo do texto. Yes
tipo enumeração O tipo da parte de conteúdo. Sempre file.
Valores possíveis: file		 Yes

OpenAI.ChatCompletionRole

A função do autor de uma mensagem

Property Value
Description A função do autor de uma mensagem
Type cadeia
Values system
developer
user
assistant
tool
function

OpenAI.ChatCompletionStreamOptions

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

Name Tipo Description Required Default
include_usage boolean Se definido, uma parte adicional será transmitida antes da data: [DONE] mensagem. O usage campo nessa parte mostra as estatísticas de uso do token para toda a solicitação e o choices campo sempre será uma matriz vazia.

Todas as outras partes também incluirão um usage campo, mas com um valor nulo. NOTA: Se o fluxo for interrompido, você poderá não receber a parte de uso final que contém o uso total do token para a solicitação.		 No

OpenAI.ChatCompletionStreamResponseDelta

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

Name Tipo Description Required Default
audio objeto No
└─ data cadeia No
└─ expires_at inteiro No
└─ id cadeia No
└─ transcript cadeia No
conteúdo cadeia O conteúdo da mensagem de parte. No
function_call objeto Preterido e substituído por tool_calls. O nome e os argumentos de uma função que deve ser chamada, conforme gerado pelo modelo. No
└─ arguments cadeia No
└─ name cadeia No
refusal cadeia A mensagem de recusa gerada pelo modelo. No
função objeto A função do autor de uma mensagem No
tool_calls matriz No

OpenAI.ChatCompletionTokenLogprob

Name Tipo Description Required Default
bytes matriz Uma lista de inteiros que representam a representação de bytes UTF-8 do token. Útil em instâncias em que os caracteres são representados por vários tokens e suas representações de bytes devem ser combinadas para gerar a representação de texto correta. Pode ser null se não houver representação de bytes para o token. Yes
logprob number A probabilidade de log desse token, se ele estiver dentro dos 20 tokens mais prováveis. Caso contrário, o valor -9999.0 é usado para significar que o token é muito improvável. Yes
símbolo cadeia The token. Yes
top_logprobs matriz Lista dos tokens mais prováveis e sua probabilidade de log, nessa posição de token. Em casos raros, pode haver menos do que o número de solicitados retornados top_logprobs . Yes

OpenAI.ChatCompletionTool

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

OpenAI.ChatCompletionToolChoiceOption

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

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

Name Tipo Description Required Default
função objeto Yes
└─ name cadeia O nome da função a ser chamada. No
tipo enumeração O tipo da ferramenta. Atualmente, só function há suporte.
Valores possíveis: function		 Yes

OpenAI.ChatOutputPrediction

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

Discriminador para OpenAI.ChatOutputPrediction

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

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

OpenAI.ChatOutputPredictionContent

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

Name Tipo Description Required Default
conteúdo cadeia de caracteres ou matriz Yes
tipo enumeração O tipo do conteúdo previsto que você deseja fornecer. Atualmente, esse tipo é sempre content.
Valores possíveis: content		 Yes

OpenAI.ChatOutputPredictionType

Property Value
Type cadeia
Values content

OpenAI.ChunkingStrategyRequestParam

A estratégia de agrupamento usada para agrupar os arquivos. Se não estiver definido, usará a auto estratégia.

Discriminatório para OpenAI.ChunkingStrategyRequestParam

Esse componente usa 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 agrupamento.
Valores possíveis: auto, static		 Yes

OpenAI.ChunkingStrategyResponseParam

Discriminador para OpenAI.ChunkingStrategyResponseParam

Esse componente usa 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

Esse componente usa 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 saída da imagem do interpretador de código.

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

OpenAI.CodeInterpreterOutputLogs

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

Name Tipo Description Required Default
logs cadeia A saída de logs do interpretador de código. Yes
tipo enumeração O tipo da saída. Always 'logs'.
Valores possíveis: logs		 Yes

OpenAI.CodeInterpreterOutputType

Property Value
Type cadeia
Values logs
image

OpenAI.CodeInterpreterTool

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

Name Tipo Description Required Default
contêiner objeto Configuração para um contêiner de interpretador de código. Opcionalmente, especifique as IDs dos arquivos nos quais executar o código. Yes
└─ file_ids matriz Uma lista opcional de arquivos carregados a serem disponibilizados para seu código. No
└─ type enumeração Sempre auto.
Valores possíveis: auto		 No
tipo enumeração O tipo da ferramenta de interpretador de código. Sempre code_interpreter.
Valores possíveis: code_interpreter		 Yes

OpenAI.CodeInterpreterToolAuto

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

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

OpenAI.CodeInterpreterToolCallItemParam

Uma chamada de ferramenta para executar o código.

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

OpenAI.CodeInterpreterToolCallItemResource

Uma chamada de ferramenta para executar o código.

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

OpenAI.ComparisonFilter

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

Name Tipo Description Required Default
chave cadeia A chave a ser comparada com o valor. Yes
tipo enumeração Especifica o operador de comparação: eq, , ne, gt, gte, lt, lte.
- eq:Equals
- ne: não é igual a
- gt: maior que
- gte: maior ou igual a
- lt: menor que
- lte: menor ou igual.
Valores possíveis: eq, , ne, gt, gte, , ltlte		 Yes
value cadeia de caracteres ou número ou booliano Yes

OpenAI.CompletionUsage

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

Name Tipo Description Required Default
completion_tokens inteiro Número de tokens na conclusão gerada. Yes 0
completion_tokens_details objeto Divisão de tokens usados em uma conclusão. No
└─ accepted_prediction_tokens inteiro Ao usar Saídas Previstas, o número de tokens na previsão que apareceu na conclusão. No 0
└─ audio_tokens inteiro Tokens de entrada de áudio gerados pelo modelo. No 0
└─ reasoning_tokens inteiro Tokens gerados pelo modelo para raciocínio. No 0
└─ rejected_prediction_tokens inteiro Ao usar Saídas Previstas, o número de tokens na previsão que não apareceu na conclusão. No entanto, como tokens de raciocínio, esses tokens ainda são contados no total de tokens de conclusão para fins de limites de janela de cobrança, saída e contexto. No 0
prompt_tokens inteiro Número de tokens no prompt. Yes 0
prompt_tokens_details objeto Divisão de tokens usados no prompt. No
└─ audio_tokens inteiro Tokens de entrada de áudio presentes no prompt. No 0
└─ cached_tokens inteiro Tokens armazenados em cache presentes no prompt. No 0
total_tokens inteiro Número total de tokens usados na solicitação (prompt + conclusão). Yes 0

OpenAI.CompoundFilter

Combinar vários filtros usando and ou or.

Name Tipo Description Required Default
filters matriz Matriz de filtros a serem combinados. Os itens podem ser ComparisonFilter ou CompoundFilter. Yes
tipo enumeração Tipo de operação: and ou or.
Valores possíveis: and, or		 Yes

OpenAI.ComputerAction

Discriminatório para OpenAI.ComputerAction

Esse componente usa 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 mouse foi pressionado durante o clique. Um de left, right, wheel, backou forward.
Valores possíveis: left, , right, wheel, back, forward		 Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de clique, essa propriedade é sempre definida como click.
Valores possíveis: click		 Yes
x inteiro A coordenada x em que o clique ocorreu. Yes
y inteiro A coordenada y em que o clique ocorreu. Yes

OpenAI.ComputerActionDoubleClick

Uma ação de clique duplo.

Name Tipo Description Required Default
tipo enumeração Especifica o tipo de evento. Para uma ação de clique duplo, essa propriedade é sempre definida como double_click.
Valores possíveis: double_click		 Yes
x inteiro A coordenada x em que o clique duplo ocorreu. Yes
y inteiro A coordenada y em que o clique duplo ocorreu. Yes

OpenAI.ComputerActionDrag

Uma ação de arrastar.

Name Tipo Description Required Default
caminho matriz Uma matriz de coordenadas que representa o caminho da ação de arrastar. As coordenadas serão exibidas como uma matriz de objetos, por exemplo,{ x: 100, y: 200 }, { x: 200, y: 300 } Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de arrastar, essa propriedade é sempre definida como drag.
Valores possíveis: drag		 Yes

OpenAI.ComputerActionKeyPress

Uma coleção de teclas que o modelo deseja executar.

Name Tipo Description Required Default
keys matriz A combinação de teclas que o modelo está solicitando que sejam pressionadas. Essa é uma matriz de cadeias de caracteres, cada uma representando uma chave. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação keypress, essa propriedade é sempre definida como keypress.
Valores possíveis: keypress		 Yes

OpenAI.ComputerActionMove

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

Name Tipo Description Required Default
tipo enumeração Especifica o tipo de evento. Para uma ação de movimentação, essa propriedade é sempre definida como move.
Valores possíveis: move		 Yes
x inteiro A coordenada x para a qual mover. Yes
y inteiro A coordenada y para a qual mover. Yes

OpenAI.ComputerActionScreenshot

Uma ação de captura de tela.

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

OpenAI.ComputerActionScroll

Uma ação de rolagem.

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

OpenAI.ComputerActionType

Property Value
Type cadeia
Values screenshot
click
double_click
scroll
type
wait
keypress
drag
move

OpenAI.ComputerActionTypeKeys

Uma ação para digitar texto.

Name Tipo Description Required Default
enviar SMS cadeia O texto a ser digitado. Yes
tipo enumeração Especifica o tipo de evento. Para uma ação de tipo, essa propriedade é sempre 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, essa propriedade é sempre definida como 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 Um identificador usado ao responder à chamada de ferramenta com saída. Yes
pending_safety_checks matriz As verificações de segurança pendentes para a chamada do computador. Yes
tipo enumeração
Valores possíveis: computer_call		 Yes

OpenAI.ComputerToolCallItemResource

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

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

OpenAI.ComputerToolCallOutputItemOutput

Discriminatório para OpenAI.ComputerToolCallOutputItemOutput

Esse componente usa 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 tela do computador usada com a ferramenta de uso do computador. Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name Tipo Description Required Default
file_id cadeia No
image_url cadeia No
tipo enumeração
Valores possíveis: computer_screenshot		 Yes

OpenAI.ComputerToolCallOutputItemOutputType

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

Property Value
Description Uma imagem de captura de tela do computador usada com a ferramenta de uso do computador.
Type cadeia
Values computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

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

Name Tipo Description Required Default
acknowledged_safety_checks matriz As verificações de segurança relatadas pela API que foram confirmadas pelo desenvolvedor. No
call_id cadeia A ID da chamada da ferramenta de computador que produziu a saída. Yes
saída OpenAI.ComputerToolCallOutputItemOutput Yes
tipo enumeração
Valores possíveis: computer_call_output		 Yes

OpenAI.ComputerToolCallOutputItemResource

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

Name Tipo Description Required Default
acknowledged_safety_checks matriz As verificações de segurança relatadas pela API que foram confirmadas pelo desenvolvedor. No
call_id cadeia A ID da chamada da ferramenta de computador que produziu a saída. Yes
saída OpenAI.ComputerToolCallOutputItemOutput Yes
status enumeração O status do item. Um de in_progress, completedou incomplete. Populado quando os itens são retornados por meio da API.
Valores possíveis: in_progress, , completedincomplete		 Yes
tipo enumeração
Valores possíveis: computer_call_output		 Yes

OpenAI.ComputerToolCallSafetyCheck

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

Name Tipo Description Required Default
codificar cadeia O tipo da verificação de segurança pendente. Yes
id cadeia A ID da verificação de segurança pendente. Yes
mensagem cadeia Detalhes sobre a verificação de segurança pendente. Yes

OpenAI.ComputerUsePreviewTool

Uma ferramenta que controla um computador virtual.

Name Tipo Description Required Default
display_height inteiro A altura da exibição do computador. Yes
display_width inteiro A largura da exibição do computador. Yes
ambiente enumeração O tipo de ambiente de computador a ser controlado.
Valores possíveis: windows, , mac, linux, ubuntu, browser		 Yes
tipo enumeração O tipo da ferramenta de uso do computador. Sempre computer_use_preview.
Valores possíveis: computer_use_preview		 Yes

OpenAI.Coordinate

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

Name Tipo Description Required Default
x inteiro The x-coordinate. Yes
y inteiro The y-coordinate. Yes

OpenAI.CreateEmbeddingResponse

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

OpenAI.CreateEvalItem

Uma mensagem de chat que compõe o prompt ou contexto. Pode incluir referências 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 caracteres de modelo. Yes
função enumeração A função da entrada da mensagem. Um de user, assistant, systemou developer.
Valores possíveis: user, , assistant, systemdeveloper		 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 objeto Yes
└─ type OpenAI.EvalRunDataSourceType No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
name cadeia O nome da execução. No

OpenAI.CreateFineTuningJobRequest

Valid models:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
Name Tipo Description Required Default
hyperparameters objeto Os hiperparâmetros usados para o trabalho de ajuste fino.
Esse valor agora foi preterido 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 habilitar seu trabalho de ajuste fino. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
método OpenAI.FineTuneMethod O método usado para ajuste fino. No
modelo cadeia de caracteres (veja os modelos válidos abaixo) O nome do modelo a ser afinado. Yes
seed inteiro A semente controla a reprodutibilidade do trabalho. Passar os mesmos parâmetros de semente e trabalho deve produzir os mesmos resultados, mas pode ser diferente em casos raros.
Se uma semente não for especificada, uma será gerada para você.		 No
suffix cadeia Uma cadeia de caracteres de até 64 caracteres que será adicionada ao seu nome de modelo ajustado.

Por exemplo, um suffix "custom-model-name" produziria um nome de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.		 No None
training_file cadeia A ID de um arquivo carregado que contém dados de treinamento. Seu conjunto de dados deve ser formatado como um arquivo JSONL. Além disso, você deve carregar seu arquivo com a finalidade fine-tune.

O conteúdo do arquivo deve ser diferente dependendo se o modelo usar o chat, o formato de conclusão ou se o método de ajuste fino usar o formato de preferência.		 Yes
validation_file cadeia A ID de um arquivo carregado que contém dados de validação.

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

Seu conjunto de dados deve ser formatado como um arquivo JSONL. Você deve carregar seu arquivo com a finalidade fine-tune.		 No

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Type Value Schema
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
Name Tipo Description Required Default
tipo cadeia de caracteres (veja os modelos válidos abaixo) Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name Tipo Description Required Default
tipo enumeração
Valores possíveis: wandb		 Yes
wandb objeto Yes
└─ entity cadeia No
└─ name cadeia No
└─ project cadeia No
└─ tags matriz No

OpenAI.CreateVectorStoreFileBatchRequest

Name Tipo Description Required Default
attributes objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, boolianos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de agrupamento usada para agrupar os arquivos. Se não estiver definido, usará a auto estratégia. No
file_ids matriz Uma lista de IDs de arquivo que o repositório de vetores deve usar. Útil para ferramentas como file_search essa que podem acessar arquivos. Yes

OpenAI.CreateVectorStoreFileRequest

Name Tipo Description Required Default
attributes objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, boolianos ou números. No
chunking_strategy OpenAI.ChunkingStrategyRequestParam A estratégia de agrupamento usada para agrupar os arquivos. Se não estiver definido, usará a auto estratégia. No
file_id cadeia Uma ID de arquivo que o repositório de vetores deve usar. Útil para ferramentas como file_search essa que podem acessar arquivos. Yes

OpenAI.CreateVectorStoreRequest

Name Tipo Description Required Default
chunking_strategy objeto A estratégia padrão. Atualmente, essa estratégia usa um max_chunk_size_tokens de 800 e chunk_overlap_tokens de 400. 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 de um repositório de vetores. No
file_ids matriz Uma lista de IDs de arquivo que o repositório de vetores deve usar. Útil para ferramentas como file_search essa que podem acessar arquivos. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
name cadeia O nome do repositório de vetores. No

OpenAI.DeleteFileResponse

Name Tipo Description Required Default
deleted boolean Yes
id cadeia Yes
objeto enumeração
Valores possíveis: file		 Yes

OpenAI.DeleteVectorStoreFileResponse

Name Tipo Description Required Default
deleted boolean Yes
id cadeia Yes
objeto enumeração
Valores possíveis: vector_store.file.deleted		 Yes

OpenAI.DeleteVectorStoreResponse

Name Tipo Description Required Default
deleted boolean Yes
id cadeia Yes
objeto enumeração
Valores possíveis: vector_store.deleted		 Yes

OpenAI.Embedding

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

Name Tipo Description Required Default
embedding matriz ou cadeia de caracteres Yes
indexar inteiro O índice da inserção na lista de inserções. Yes
objeto enumeração O tipo de objeto, que é sempre "embedding".
Valores possíveis: embedding		 Yes

OpenAI.Eval

Um objeto Eval com critérios de teste e configuração de fonte de dados. Um Eval representa uma tarefa a ser feita para a integração do LLM. Like:

  • Melhorar a qualidade do meu chatbot
  • Veja como meu chatbot lida bem com o suporte ao cliente
  • Verifique se o o4-mini é melhor em meu uso do que gpt-4o
Name Tipo Description Required Default
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando a eval foi criada. Yes
data_source_config objeto Yes
└─ type OpenAI.EvalDataSourceConfigType No
id cadeia Identificador exclusivo para a avaliação. Yes
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
name cadeia O nome da avaliação. Yes
objeto 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 de Eval.

Name Tipo Description Required Default
codificar cadeia O código de erro. Yes
mensagem cadeia 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 objeto No
└─ item_reference cadeia 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 o contexto. Pode incluir referências 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 O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini"). No
sampling_params AzureEvalAPICompletionsSamplingParams No
fonte objeto Yes
└─ content matriz O conteúdo do arquivo jsonl. No
└─ created_after inteiro Um carimbo de data/hora opcional do Unix para filtrar itens criados após esse momento. No
└─ created_before inteiro Um carimbo de data/hora opcional do Unix para filtrar itens criados antes desta vez. No
└─ id cadeia O identificador do arquivo. No
└─ limit inteiro Um número máximo opcional de itens a serem retornados. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ model cadeia Um modelo opcional para filtrar (por exemplo, 'gpt-4o'). No
└─ type enumeração O tipo de origem. 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 da fonte de dados usada para as execuções de avaliação. Esse esquema é usado para definir a forma dos dados que serão:

  • Usado para definir seus critérios de teste e
  • Quais dados são necessários ao criar uma execução
Name Tipo Description Required Default
include_sample_schema boolean Se a avaliação deve esperar que você preencha o namespace de exemplo (ou seja, gerando respostas fora da fonte de dados) No False
item_schema objeto O esquema json para cada linha na fonte de dados. Yes
tipo enumeração O tipo de fonte de dados. Sempre custom.
Valores possíveis: custom		 Yes

OpenAI.EvalCustomDataSourceConfigResource

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

  • Usado para definir seus critérios de teste e
  • Quais dados são necessários ao criar uma execução
Name Tipo Description Required Default
esquema objeto O esquema json para os itens de fonte de dados de execução.
Saiba como criar esquemas JSON aqui.		 Yes
tipo enumeração O tipo de fonte de dados. Sempre custom.
Valores possíveis: custom		 Yes

OpenAI.EvalDataSourceConfigParams

Discriminador para OpenAI.EvalDataSourceConfigParams

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

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

Esse componente usa 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
Values custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

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

Name Tipo Description Required Default
entrada matriz Uma lista de mensagens de chat que formam o prompt ou o contexto. Pode incluir referências variáveis ao item namespace, ou seja, {{item.name}}. Yes
labels matriz Os rótulos a serem classificados para cada item na avaliação. Yes
modelo cadeia O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas. Yes
name cadeia O nome do classificador. Yes
passing_labels matriz Os rótulos que indicam um resultado de passagem. 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
entrada matriz Yes
labels matriz Os rótulos a serem atribuídos a cada item na avaliação. Yes
modelo cadeia O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas. Yes
name cadeia O nome do classificador. Yes
passing_labels matriz Os rótulos que indicam um resultado de passagem. Deve ser um subconjunto de rótulos. Yes
tipo enumeração O tipo de objeto, que é sempre label_model.
Valores possíveis: label_model		 Yes

OpenAI.EvalGraderParams

Discriminador para OpenAI.EvalGraderParams

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

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 A marca de imagem a ser usada para o script python. No
name cadeia O nome do classificador. Yes
pass_threshold number O limite para a pontuação. No
fonte cadeia O código-fonte do script python. Yes
tipo enumeração O tipo de objeto, que é sempre python.
Valores possíveis: python		 Yes

OpenAI.EvalGraderPythonResource

Name Tipo Description Required Default
image_tag cadeia A marca de imagem a ser usada para o script python. No
name cadeia O nome do classificador. Yes
pass_threshold number O limite para a pontuação. No
fonte cadeia O código-fonte do script python. Yes
tipo enumeração O tipo de objeto, que é sempre python.
Valores possíveis: python		 Yes

OpenAI.EvalGraderResource

Discriminador para OpenAI.EvalGraderResource

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

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
entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
modelo cadeia O modelo a ser usado para a avaliação. Yes
name cadeia O nome do classificador. Yes
pass_threshold number O limite para a pontuação. No
alcance matriz O intervalo da pontuação. O padrão é [0, 1]. No
sampling_params Os parâmetros de amostragem do 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
entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
modelo cadeia O modelo a ser usado para a avaliação. Yes
name cadeia O nome do classificador. Yes
pass_threshold number O limite para a pontuação. No
alcance matriz O intervalo da pontuação. O padrão é [0, 1]. No
sampling_params Os parâmetros de amostragem do 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
entrada cadeia O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
name cadeia O nome do classificador. Yes
operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 Yes
referência cadeia O texto de referência. Isso pode incluir cadeias de caracteres de modelo. Yes
tipo enumeração O tipo de objeto, que é sempre string_check.
Valores possíveis: string_check		 Yes

OpenAI.EvalGraderTextSimilarityParams

Name Tipo Description Required Default
evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 Yes
entrada cadeia O texto que está sendo classificado. Yes
name cadeia O nome do classificador. Yes
pass_threshold number O limite para a pontuação. Yes
referência cadeia O texto que está sendo classificado. Yes
tipo enumeração O tipo de classificador.
Valores possíveis: text_similarity		 Yes

OpenAI.EvalGraderTextSimilarityResource

Name Tipo Description Required Default
evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 Yes
entrada cadeia O texto que está sendo classificado. Yes
name cadeia O nome do classificador. Yes
pass_threshold number O limite para a pontuação. Yes
referência cadeia O texto que está sendo classificado. Yes
tipo enumeração O tipo de classificador.
Valores possíveis: text_similarity		 Yes

OpenAI.EvalItem

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

Name Tipo Description Required Default
conteúdo objeto Yes
└─ type OpenAI.EvalItemContentType No
função enumeração A função da entrada da mensagem. Um de user, assistant, systemou developer.
Valores possíveis: user, , assistant, systemdeveloper		 Yes
tipo enumeração O tipo de entrada da mensagem. Sempre message.
Valores possíveis: message		 No

OpenAI.EvalItemContent

Discriminador para OpenAI.EvalItemContent

Esse componente usa 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 Yes
tipo enumeração
Valores possíveis: input_text		 Yes

OpenAI.EvalItemContentOutputText

Name Tipo Description Required Default
enviar SMS cadeia Yes
tipo enumeração
Valores possíveis: output_text		 Yes

OpenAI.EvalItemContentType

Property Value
Type cadeia
Values input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

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

Name Tipo Description Required Default
fonte objeto Yes
└─ content matriz O conteúdo do arquivo jsonl. No
└─ id cadeia O identificador do arquivo. No
└─ type enumeração O tipo de origem 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 valores.

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

OpenAI.EvalLogsDataSourceConfigParams

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

Name Tipo Description Required Default
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 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 consulta de logs. Geralmente, são metadados como usecase=chatbot ou prompt-version=v2etc. O esquema retornado por essa configuração de fonte de dados é usado para definir quais variáveis estão disponíveis em suas avaliações. item e sample ambos são definidos ao usar essa configuração de fonte de dados.

Name Tipo Description Required Default
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
esquema objeto O esquema json para os itens de fonte de dados de execução.
Saiba como criar esquemas JSON aqui.		 Yes
tipo enumeração O tipo de fonte de dados. Sempre logs.
Valores possíveis: logs		 Yes

OpenAI.EvalResponsesRunDataSourceParams

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

Name Tipo Description Required Default
input_messages objeto No
└─ item_reference cadeia 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 o contexto. Pode incluir referências 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 O nome do modelo a ser usado para gerar conclusões (por exemplo, "o3-mini"). No
sampling_params AzureEvalAPIResponseSamplingParams No
fonte objeto Yes
└─ content matriz O conteúdo do arquivo jsonl. No
└─ created_after inteiro Inclua somente itens criados após esse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ created_before inteiro Inclua somente itens criados antes desse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ id cadeia O identificador do arquivo. No
└─ instructions_search cadeia Cadeia de caracteres opcional para pesquisar o campo 'instruções'. Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ model cadeia O nome do modelo para o qual encontrar respostas. Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ reasoning_effort OpenAI.ReasoningEffort Parâmetro de esforço de raciocínio opcional. Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ temperature number Sampling temperature. Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ tools matriz Lista de nomes de ferramentas. Esse é um parâmetro de consulta usado para selecionar respostas. No
└─ top_p number Parâmetro de amostragem de núcleo. Esse é 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 usuário. Esse é 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 inteiro Unix timestamp (em segundos) quando a execução de avaliação foi criada. Yes
data_source objeto Yes
└─ type OpenAI.EvalRunDataSourceType No
erro OpenAI.EvalApiError Um objeto que representa uma resposta de erro da API de Eval. Yes
eval_id cadeia O identificador da avaliação associada. Yes
id cadeia Identificador exclusivo para a execução da avaliação. Yes
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
modelo cadeia O modelo que é avaliado, se aplicável. Yes
name cadeia O nome da execução de avaliação. Yes
objeto enumeração O tipo do objeto. Always "eval.run".
Valores possíveis: eval.run		 Yes
per_model_usage matriz Estatísticas de uso para cada modelo durante a execução da avaliação. Yes
per_testing_criteria_results matriz Resultados por critérios de teste aplicados durante a execução da avaliação. Yes
report_url cadeia A URL para o relatório de execução de avaliação renderizada no painel da interface do usuário. Yes
result_counts objeto Contadores resumindo os resultados da execução de avaliação. Yes
└─ errored inteiro Número de itens de saída que resultaram em um erro. No
└─ failed inteiro Número de itens de saída que não passaram na avaliação. No
└─ passed inteiro Número de itens de saída que passaram na avaliação. No
└─ total inteiro Número total de itens de saída executados. No
status cadeia O status da execução de avaliação. Yes

OpenAI.EvalRunDataContentSource

Discriminador para OpenAI.EvalRunDataContentSource

Esse componente usa 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
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

Esse componente usa 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
Values jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

Name Tipo Description Required Default
conteúdo matriz O conteúdo do arquivo jsonl. Yes
tipo enumeração O tipo de origem jsonl. Sempre file_content.
Valores possíveis: file_content		 Yes

OpenAI.EvalRunFileIdDataContentSource

Name Tipo Description Required Default
id cadeia O identificador do arquivo. Yes
tipo enumeração O tipo de origem 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 matriz de objetos de execução de avaliação. Yes
first_id cadeia O identificador da primeira execução de avaliação na matriz de dados. Yes
has_more boolean Indica se há mais avaliações disponíveis. Yes
last_id cadeia O identificador da última execução de avaliação na matriz de dados. Yes
objeto enumeração O tipo desse objeto. Ele é sempre definido como "lista".
Valores possíveis: list		 Yes

OpenAI.EvalRunOutputItem

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

Name Tipo Description Required Default
created_at inteiro Unix timestamp (em segundos) quando a execução de avaliação foi criada. Yes
datasource_item objeto Detalhes do item de fonte de dados de entrada. Yes
datasource_item_id inteiro O identificador do item da fonte de dados. Yes
eval_id cadeia O identificador do grupo de avaliação. Yes
id cadeia Identificador exclusivo para o item de saída de execução de avaliação. Yes
objeto 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 execução de avaliação. Yes
run_id cadeia O identificador da execução de avaliação associada a este item de saída. Yes
amostra objeto Um exemplo que contém a entrada e a saída da execução de avaliação. Yes
└─ error OpenAI.EvalApiError Um objeto que representa uma resposta de erro da API de Eval. No
└─ finish_reason cadeia O motivo pelo qual a geração de exemplo foi concluída. No
└─ input matriz Uma matriz de mensagens de entrada. No
└─ max_completion_tokens inteiro O número máximo de tokens permitidos para conclusão. No
└─ model cadeia O modelo usado para gerar o exemplo. No
└─ output matriz Uma matriz de mensagens de saída. No
└─ seed inteiro A semente usada para gerar o exemplo. No
└─ temperature number A temperatura de amostragem usada. No
└─ top_p number O valor top_p usado para amostragem. No
└─ usage objeto Detalhes de uso do token para o exemplo. No
└─ cached_tokens inteiro O número de tokens recuperados do cache. No
└─ completion_tokens inteiro O número de tokens de conclusão gerados. No
└─ prompt_tokens inteiro O número de tokens de prompt usados. No
└─ total_tokens inteiro O número total de tokens usados. No
status cadeia O status da execução 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 Uma matriz de objetos de item de saída de execução de avaliação. Yes
first_id cadeia O identificador do primeiro item de saída de execução de avaliação na matriz de dados. Yes
has_more boolean Indica se há mais itens de saída de execução de avaliação disponíveis. Yes
last_id cadeia O identificador do último item de saída de execução de avaliação na matriz de dados. Yes
objeto enumeração O tipo desse objeto. Ele é sempre definido como "lista".
Valores possíveis: list		 Yes

OpenAI.EvalRunResponsesDataContentSource

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

Name Tipo Description Required Default
created_after inteiro Inclua somente itens criados após esse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas. No
created_before inteiro Inclua somente itens criados antes desse carimbo de data/hora (inclusive). Esse é um parâmetro de consulta usado para selecionar respostas. No
instructions_search cadeia Cadeia de caracteres opcional para pesquisar o campo 'instruções'. Esse é um parâmetro de consulta usado para selecionar respostas. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
modelo cadeia O nome do modelo para o qual encontrar respostas. Esse é um parâmetro de consulta usado para selecionar respostas. No
reasoning_effort objeto somente modelos da série o

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
temperature number Sampling temperature. Esse é um parâmetro de consulta usado para selecionar respostas. No
tools matriz Lista de nomes de ferramentas. Esse é um parâmetro de consulta usado para selecionar respostas. No
top_p number Parâmetro de amostragem de núcleo. Esse é 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 usuário. Esse é 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 inteiro Um carimbo de data/hora opcional do Unix para filtrar itens criados após esse momento. No
created_before inteiro Um carimbo de data/hora opcional do Unix para filtrar itens criados antes desta vez. No
limit inteiro Um número máximo opcional de itens a serem retornados. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
modelo cadeia Um modelo opcional para filtrar (por exemplo, 'gpt-4o'). No
tipo enumeração O tipo de origem. Sempre stored_completions.
Valores possíveis: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

Preterido em favor de LogsDataSourceConfig.

Name Tipo Description Required Default
metadados objeto Filtros de metadados para a fonte de dados de conclusões armazenadas. No
tipo enumeração O tipo de fonte de dados. Sempre stored_completions.
Valores possíveis: stored_completions		 Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

Preterido em favor de LogsDataSourceConfig.

Name Tipo Description Required Default
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
esquema objeto O esquema json para os itens de fonte de dados de execução.
Saiba como criar esquemas JSON aqui.		 Yes
tipo enumeração O tipo de fonte de dados. Sempre stored_completions.
Valores possíveis: stored_completions		 Yes

OpenAI.FileSearchTool

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

Name Tipo Description Required Default
filters objeto No
max_num_results inteiro O número máximo de resultados a serem retornados. Esse número deve estar entre 1 e 50, inclusive. No
ranking_options objeto No
└─ ranker enumeração O classificador a ser usado para a pesquisa de arquivos.
Valores possíveis: auto, default-2024-11-15		 No
└─ score_threshold number O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados. No
tipo enumeração O tipo da ferramenta de pesquisa de arquivo. Sempre file_search.
Valores possíveis: file_search		 Yes
vector_store_ids matriz As IDs dos repositórios de vetores a serem pesquisadas. Yes

OpenAI.FileSearchToolCallItemParam

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

Name Tipo Description Required Default
queries matriz As consultas usadas para pesquisar arquivos. Yes
results matriz Os resultados da chamada da ferramenta de pesquisa de arquivos. No
tipo enumeração
Valores possíveis: file_search_call		 Yes

OpenAI.FileSearchToolCallItemResource

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

Name Tipo Description Required Default
queries matriz As consultas usadas para pesquisar arquivos. Yes
results matriz Os resultados da chamada da ferramenta de pesquisa de arquivos. No
status enumeração O status da chamada da ferramenta de pesquisa de arquivos. Um de in_progress, searchingincomplete 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 Matriz de filtros a serem combinados. Os itens podem ser ComparisonFilter ou CompoundFilter. Yes
chave cadeia A chave a ser comparada com o valor. Yes
tipo enumeração Tipo de operação: and ou or.
Valores possíveis: and, or		 Yes
value cadeia de caracteres ou número ou booliano O valor a ser comparado com a chave de atributo; dá suporte a tipos de cadeia de caracteres, número ou booliano. Yes

OpenAI.FineTuneDPOHyperparameters

Os hiperparâmetros usados 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 do método de ajuste fino do 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 ajuste fino.

Name Tipo Description Required Default
dpo OpenAI.FineTuneDPOMethod Configuração do método de ajuste fino do DPO. No
reinforcement AzureFineTuneReinforcementMethod No
supervised OpenAI.FineTuneSupervisedMethod Configuração do método de ajuste fino supervisionado. No
tipo enumeração O tipo de método. É, superviseddpoou reinforcement.
Valores possíveis: supervised, , dporeinforcement		 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, mediumhigh		 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 do método de ajuste fino supervisionado.

Name Tipo Description Required Default
hyperparameters OpenAI.FineTuneSupervisedHyperparameters Os hiperparâmetros usados para o trabalho de ajuste fino. No

OpenAI.FineTuningIntegration

Discriminatório para OpenAI.FineTuningIntegration

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

Type Value Schema
wandb OpenAI.FineTuningIntegrationWandb
Name Tipo Description Required Default
tipo cadeia de caracteres (veja os modelos válidos abaixo) Yes

OpenAI.FineTuningIntegrationWandb

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

OpenAI.FineTuningJob

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

Name Tipo Description Required Default
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando o trabalho de ajuste fino foi criado. Yes
erro objeto Para trabalhos de ajuste fino que têm failed, isso conterá mais informações sobre a causa da falha. Yes
└─ code cadeia Um código de erro legível pelo computador. No
└─ message cadeia Uma mensagem de erro legível por humanos. No
└─ param cadeia O parâmetro que era inválido, geralmente training_file ou validation_file. Esse campo será nulo se a falha não tiver sido específica do parâmetro. No
estimated_finish inteiro O carimbo de data/hora unix (em segundos) para quando o trabalho de ajuste fino é estimado para ser concluído. O valor será nulo se o trabalho de ajuste fino não estiver em execução. No
fine_tuned_model cadeia O nome do modelo ajustado que está sendo criado. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução. Yes
finished_at inteiro O carimbo de data/hora unix (em segundos) para quando o trabalho de ajuste fino foi concluído. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução. Yes
hyperparameters objeto Os hiperparâmetros usados para o trabalho de ajuste fino. Esse valor só será retornado 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 O identificador de objeto, que pode ser referenciado nos pontos de extremidade da API. Yes
integrations matriz Uma lista de integrações para habilitar esse trabalho de ajuste fino. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
método OpenAI.FineTuneMethod O método usado para ajuste fino. No
modelo cadeia O modelo base que está sendo ajustado. Yes
objeto enumeração O tipo de objeto, que é sempre "fine_tuning.job".
Valores possíveis: fine_tuning.job		 Yes
organization_id cadeia A organização que possui o trabalho de ajuste fino. Yes
result_files matriz As IDs do arquivo de resultados compilados para o trabalho de ajuste fino. Você pode recuperar os resultados com a API de Arquivos. Yes
seed inteiro A semente usada para o trabalho de ajuste fino. Yes
status enumeração O status atual do trabalho de ajuste fino, que pode ser, , validating_files, , queuedrunning, ou succeededfailed.cancelled
Valores possíveis: validating_files, , queued, running, succeeded, , failedcancelled		 Yes
trained_tokens inteiro O número total de tokens faturáveis processados por esse trabalho de ajuste fino. O valor será nulo se o trabalho de ajuste fino ainda estiver em execução. Yes
training_file cadeia A ID do arquivo usada para treinamento. Você pode recuperar os dados de treinamento com a API de Arquivos. Yes
user_provided_suffix cadeia O sufixo descritivo aplicado ao trabalho, conforme especificado na solicitação de criação de trabalho. No
validation_file cadeia A ID do arquivo usada para validação. Você pode recuperar os resultados de validação com a API de Arquivos. Yes

OpenAI.FineTuningJobCheckpoint

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

Name Tipo Description Required Default
created_at inteiro O carimbo de data/hora unix (em segundos) para quando o ponto de verificação foi criado. Yes
fine_tuned_model_checkpoint cadeia O nome do modelo de ponto de verificação ajustado que é criado. Yes
fine_tuning_job_id cadeia O nome do trabalho de ajuste fino do qual esse ponto de verificação foi criado. Yes
id cadeia O identificador de ponto de verificação, que pode ser referenciado nos pontos de extremidade da API. Yes
métricas objeto Métricas no número da etapa durante o trabalho de ajuste fino. Yes
└─ full_valid_loss 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
objeto enumeração O tipo de objeto, que é sempre "fine_tuning.job.checkpoint".
Valores possíveis: fine_tuning.job.checkpoint		 Yes
step_number inteiro O número da etapa em que o ponto de verificação foi criado. Yes

OpenAI.FineTuningJobEvent

Objeto de evento de trabalho de ajuste fino

Name Tipo Description Required Default
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando o trabalho de ajuste fino foi criado. Yes
dados Os dados associados ao evento. No
id cadeia O identificador do objeto. Yes
nível enumeração O nível de log do evento.
Valores possíveis: info, , warnerror		 Yes
mensagem cadeia A mensagem do evento. Yes
objeto enumeração O tipo de objeto, 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 Uma descrição do que a função faz, usada pelo modelo para escolher quando e como chamar a função. No
name cadeia O nome da função a ser chamada. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
parameters Os parâmetros que as funções aceitam, descritos como um objeto de esquema JSON. No
strict boolean Se deseja habilitar a adesão estrita do esquema ao gerar a chamada de função. Se definido como true, o modelo seguirá o esquema exato definido no parameters campo. Somente um subconjunto de esquema JSON tem suporte quando strict é true. No False

OpenAI.FunctionTool

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

Name Tipo Description Required Default
description cadeia Uma descrição da função. Usado pelo modelo para determinar se a função deve ou não ser chamada. No
name cadeia O nome da função a ser chamada. Yes
parameters Um objeto de esquema JSON que descreve os parâmetros da função. Yes
strict boolean Se deve impor a validação estrita de parâmetro. Padrão true. Yes
tipo enumeração O tipo da ferramenta de função. Sempre function.
Valores possíveis: function		 Yes

OpenAI.FunctionToolCallItemParam

Uma chamada de ferramenta para executar uma função.

Name Tipo Description Required Default
arguments cadeia Uma cadeia de caracteres JSON dos argumentos a serem passados para a função. Yes
call_id cadeia A ID exclusiva da chamada da ferramenta de função gerada pelo modelo. Yes
name cadeia O nome da função a ser executada. Yes
tipo enumeração
Valores possíveis: function_call		 Yes

OpenAI.FunctionToolCallItemResource

Uma chamada de ferramenta para executar uma função.

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

OpenAI.FunctionToolCallOutputItemParam

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

Name Tipo Description Required Default
call_id cadeia A ID exclusiva da chamada da ferramenta de função gerada pelo modelo. Yes
saída cadeia Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função. Yes
tipo enumeração
Valores possíveis: function_call_output		 Yes

OpenAI.FunctionToolCallOutputItemResource

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

Name Tipo Description Required Default
call_id cadeia A ID exclusiva da chamada da ferramenta de função gerada pelo modelo. Yes
saída cadeia Uma cadeia de caracteres JSON da saída da chamada da ferramenta de função. Yes
status enumeração O status do item. Um de in_progress, completedou incomplete. Populado quando os itens são retornados por meio da API.
Valores possíveis: in_progress, , completedincomplete		 Yes
tipo enumeração
Valores possíveis: function_call_output		 Yes

OpenAI.Grader

Discriminador para OpenAI.Grader

Esse componente usa 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 usa um modelo para atribuir rótulos a cada item na avaliação.

Name Tipo Description Required Default
entrada matriz Yes
labels matriz Os rótulos a serem atribuídos a cada item na avaliação. Yes
modelo cadeia O modelo a ser usado para a avaliação. Deve dar suporte a saídas estruturadas. Yes
name cadeia O nome do classificador. Yes
passing_labels matriz Os rótulos que indicam um resultado de passagem. 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 alunos para produzir uma pontuação única.

Name Tipo Description Required Default
calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. Yes
graders objeto Yes
name cadeia O nome do classificador. Yes
tipo enumeração O tipo de objeto, que é sempre multi.
Valores possíveis: multi		 Yes

OpenAI.GraderPython

Um objeto PythonGrader que executa um script python na entrada.

Name Tipo Description Required Default
image_tag cadeia A marca de imagem a ser usada para o script python. No
name cadeia O nome do classificador. Yes
fonte cadeia O código-fonte do script python. Yes
tipo enumeração O tipo de objeto, que é sempre python.
Valores possíveis: python		 Yes

OpenAI.GraderScoreModel

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

Name Tipo Description Required Default
entrada matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
modelo cadeia O modelo a ser usado para a avaliação. Yes
name cadeia O nome do classificador. Yes
alcance matriz O intervalo da pontuação. O padrão é [0, 1]. No
sampling_params Os parâmetros de amostragem do 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 executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada.

Name Tipo Description Required Default
entrada cadeia O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. Yes
name cadeia O nome do classificador. Yes
operação enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 Yes
referência cadeia O texto de referência. Isso pode incluir cadeias de caracteres de modelo. Yes
tipo enumeração O tipo de objeto, que é sempre string_check.
Valores possíveis: string_check		 Yes

OpenAI.GraderTextSimilarity

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

Name Tipo Description Required Default
evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 Yes
entrada cadeia O texto que está sendo classificado. Yes
name cadeia O nome do classificador. Yes
referência cadeia O texto que está sendo classificado. Yes
tipo enumeração O tipo de classificador.
Valores possíveis: text_similarity		 Yes

OpenAI.GraderType

Property Value
Type cadeia
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 Somente GPT-image-1: tipo de plano de fundo para a imagem gerada. Um de transparent, opaqueou auto. Padrão: auto.
Valores possíveis: transparent, , opaqueauto		 No
input_image_mask objeto Máscara opcional para a insintação. Contém image_url (cadeia de caracteres, opcional) e file_id (cadeia de caracteres, opcional). No
└─ file_id cadeia ID do arquivo para a imagem da máscara. No
└─ image_url cadeia Imagem de máscara codificada em Base64. No
modelo enumeração O modelo de geração de imagem a ser usado. Padrão: gpt-image-1.
Valores possíveis: gpt-image-1, , gpt-image-1.5gpt-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 inteiro Nível de compactaçã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, webpou jpeg. Padrão: png.
Valores possíveis: png, , webpjpeg		 No
partial_images inteiro Número de imagens parciais a serem geradas no modo de streaming, de 0 (valor padrão) a 3. No 0
quality enumeração A qualidade da imagem gerada. Um de low, medium, highou auto. Padrão: auto.
Valores possíveis: low, , medium, highauto		 No
size enumeração O tamanho da imagem gerada. Um de 1024x1024, 1024x1536, 1536x1024ou auto. Padrão: auto.
Valores possíveis: 1024x1024, , 1024x1536, 1536x1024auto		 No
tipo enumeração O tipo da ferramenta de geração de imagem. Sempre image_generation.
Valores possíveis: image_generation		 Yes

OpenAI.ImageGenToolCallItemParam

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

Name Tipo Description Required Default
result cadeia A imagem gerada codificada em base64. Yes
tipo enumeração
Valores possíveis: image_generation_call		 Yes

OpenAI.ImageGenToolCallItemResource

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

Name Tipo Description Required Default
result cadeia A imagem gerada codificada em base64. Yes
status enumeração
Valores possíveis: in_progress, , completed, generatingfailed		 Yes
tipo enumeração
Valores possíveis: image_generation_call		 Yes

OpenAI.ImplicitUserMessage

Name Tipo Description Required Default
conteúdo cadeia de caracteres ou matriz Yes

OpenAI.Includable

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

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

Esse componente usa 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údo de entrada e saída multi modal. Yes

OpenAI.ItemContentInputAudio

Uma entrada de áudio para o modelo.

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

OpenAI.ItemContentInputFile

Uma entrada de arquivo para o modelo.

Name Tipo Description Required Default
file_data cadeia O conteúdo do arquivo a ser enviado para o modelo. No
file_id cadeia A ID do arquivo a ser enviado para o modelo. No
filename cadeia O nome do arquivo a ser enviado para o 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 detalhes da imagem a ser enviada para o modelo. Um de high, lowou auto. O padrão é auto.
Valores possíveis: low, , highauto		 No
file_id cadeia A ID do arquivo a ser enviado para o modelo. No
image_url cadeia A URL da imagem a ser enviada para o modelo. Uma URL totalmente qualificada ou uma imagem codificada em base64 em uma URL de dados. 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 A entrada de texto para o modelo. Yes
tipo enumeração O tipo do item de entrada. Sempre input_text.
Valores possíveis: input_text		 Yes

OpenAI.ItemContentOutputAudio

Uma saída de áudio do modelo.

Name Tipo Description Required Default
dados cadeia Dados de áudio codificados em Base64 do modelo. Yes
transcrição cadeia A transcrição dos dados de áudio do modelo. Yes
tipo enumeração O tipo do áudio de saída. Sempre output_audio.
Valores possíveis: output_audio		 Yes

OpenAI.ItemContentOutputText

Uma saída de texto do modelo.

Name Tipo Description Required Default
annotations matriz As anotações da saída de texto. Yes
logprobs matriz No
enviar SMS cadeia A saída de texto do modelo. Yes
tipo enumeração O tipo do texto de saída. Sempre output_text.
Valores possíveis: output_text		 Yes

OpenAI.ItemContentRefusal

Uma recusa do modelo.

Name Tipo Description Required Default
refusal cadeia As explicações de recusa do modelo. Yes
tipo enumeração O tipo da recusa. Sempre refusal.
Valores possíveis: refusal		 Yes

OpenAI.ItemContentType

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

Property Value
Description Conteúdo de entrada e saída multi modal.
Type cadeia
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

Esse componente usa 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 a ser referenciado.

Name Tipo Description Required Default
id cadeia A ID originada pelo serviço do item de resposta gerado anteriormente sendo referenciado. Yes
tipo enumeração
Valores possíveis: item_reference		 Yes

OpenAI.ItemResource

Item de conteúdo usado para gerar uma resposta.

Discriminador para OpenAI.ItemResource

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

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

OpenAI.ItemType

Property Value
Type cadeia
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 No
has_more boolean Yes
last_id cadeia No
objeto enumeração
Valores possíveis: list		 Yes

OpenAI.ListFineTuningJobEventsResponse

Name Tipo Description Required Default
dados matriz Yes
has_more boolean Yes
objeto enumeração
Valores possíveis: list		 Yes

OpenAI.ListModelsResponse

Name Tipo Description Required Default
dados matriz Yes
objeto enumeração
Valores possíveis: list		 Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name Tipo Description Required Default
dados matriz Yes
has_more boolean Yes
objeto enumeração
Valores possíveis: list		 Yes

OpenAI.ListVectorStoreFilesFilter

Property Value
Type cadeia
Values in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia Yes
has_more boolean Yes
last_id cadeia Yes
objeto enumeração
Valores possíveis: list		 Yes

OpenAI.ListVectorStoresResponse

Name Tipo Description Required Default
dados matriz Yes
first_id cadeia Yes
has_more boolean Yes
last_id cadeia Yes
objeto enumeração
Valores possíveis: list		 Yes

OpenAI.LocalShellExecAction

Execute um comando shell no servidor.

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

OpenAI.LocalShellTool

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

Name Tipo Description Required Default
tipo enumeração O tipo da ferramenta de shell local. Sempre local_shell.
Valores possíveis: local_shell		 Yes

OpenAI.LocalShellToolCallItemParam

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

Name Tipo Description Required Default
ação OpenAI.LocalShellExecAction Execute um comando shell no servidor. Yes
call_id cadeia A ID exclusiva da chamada da ferramenta de shell local gerada pelo modelo. Yes
tipo enumeração
Valores possíveis: local_shell_call		 Yes

OpenAI.LocalShellToolCallItemResource

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

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

OpenAI.LocalShellToolCallOutputItemParam

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

Name Tipo Description Required Default
saída cadeia Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local. Yes
tipo enumeração
Valores possíveis: local_shell_call_output		 Yes

OpenAI.LocalShellToolCallOutputItemResource

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

Name Tipo Description Required Default
saída cadeia Uma cadeia de caracteres JSON da saída da chamada da ferramenta de shell local. Yes
status enumeração
Valores possíveis: in_progress, , completedincomplete		 Yes
tipo enumeração
Valores possíveis: local_shell_call_output		 Yes

OpenAI.Location

Discriminador para OpenAI.Location

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

Type Value Schema
approximate OpenAI.ApproximateLocation
Name Tipo Description Required Default
tipo OpenAI.LocationType Yes

OpenAI.LocationType

Property Value
Type cadeia
Values approximate

OpenAI.LogProb

A probabilidade de log de um token.

Name Tipo Description Required Default
bytes matriz Yes
logprob number Yes
símbolo cadeia Yes
top_logprobs matriz Yes

OpenAI.MCPApprovalRequestItemParam

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

Name Tipo Description Required Default
arguments cadeia Uma cadeia de caracteres JSON de argumentos para a ferramenta. Yes
name cadeia O nome da ferramenta a ser executada. Yes
server_label cadeia O rótulo do servidor MCP que está fazendo a solicitação. Yes
tipo enumeração
Valores possíveis: mcp_approval_request		 Yes

OpenAI.MCPApprovalRequestItemResource

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

Name Tipo Description Required Default
arguments cadeia Uma cadeia de caracteres JSON de argumentos para a ferramenta. Yes
name cadeia O nome da ferramenta a ser executada. Yes
server_label cadeia O rótulo do servidor MCP que está fazendo a solicitação. Yes
tipo enumeração
Valores possíveis: mcp_approval_request		 Yes

OpenAI.MCPApprovalResponseItemParam

Uma resposta a uma solicitação de aprovação do MCP.

Name Tipo Description Required Default
approval_request_id cadeia A ID da solicitação de aprovação que está sendo respondida. Yes
approve boolean Se a solicitação foi aprovada. Yes
reason cadeia Motivo opcional para a decisão. No
tipo enumeração
Valores possíveis: mcp_approval_response		 Yes

OpenAI.MCPApprovalResponseItemResource

Uma resposta a uma solicitação de aprovação do MCP.

Name Tipo Description Required Default
approval_request_id cadeia A ID da solicitação de aprovação que está sendo respondida. Yes
approve boolean Se a solicitação foi aprovada. Yes
reason cadeia 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 em um servidor MCP.

Name Tipo Description Required Default
arguments cadeia Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta. Yes
erro cadeia O erro da chamada da ferramenta, se houver. No
name cadeia O nome da ferramenta que foi executada. Yes
saída cadeia A saída da chamada da ferramenta. No
server_label cadeia O rótulo do servidor MCP que executa a ferramenta. Yes
tipo enumeração
Valores possíveis: mcp_call		 Yes

OpenAI.MCPCallItemResource

Uma invocação de uma ferramenta em um servidor MCP.

Name Tipo Description Required Default
arguments cadeia Uma cadeia de caracteres JSON dos argumentos passados para a ferramenta. Yes
erro cadeia O erro da chamada da ferramenta, se houver. No
name cadeia O nome da ferramenta que foi executada. Yes
saída cadeia A saída da chamada da ferramenta. No
server_label cadeia O rótulo do servidor MCP que executa a ferramenta. Yes
tipo enumeração
Valores possíveis: mcp_call		 Yes

OpenAI.MCPListToolsItemParam

Uma lista de ferramentas disponíveis em um servidor MCP.

Name Tipo Description Required Default
erro cadeia Mensagem de erro se o servidor não puder listar ferramentas. No
server_label cadeia 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 em um servidor MCP.

Name Tipo Description Required Default
erro cadeia Mensagem de erro se o servidor não puder listar ferramentas. No
server_label cadeia 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 em um servidor MCP.

Name Tipo Description Required Default
annotations Anotações adicionais sobre a ferramenta. No
description cadeia A descrição da ferramenta. No
input_schema O esquema JSON que descreve a entrada da ferramenta. Yes
name cadeia O nome da ferramenta. Yes

OpenAI.MCPTool

Conceda ao modelo acesso a ferramentas adicionais por meio de servidores remotos do PROTOCOLO MCP (Protocolo de Contexto de Modelo).

Name Tipo Description Required Default
allowed_tools objeto No
└─ tool_names matriz Lista de nomes de ferramentas permitidos. No
headers objeto Cabeçalhos HTTP opcionais para enviar ao servidor MCP. Use para autenticação ou outras finalidades. No
require_approval objeto (consulte modelos válidos abaixo) Especifique quais das ferramentas do servidor MCP exigem aprovação. No
server_label cadeia Um rótulo para esse servidor MCP, usado para identificá-lo em chamadas de ferramenta. Yes
server_url cadeia A URL do servidor MCP. Yes
tipo enumeração O tipo da ferramenta MCP. Sempre mcp.
Valores possíveis: mcp		 Yes

OpenAI.MetadataPropertyForRequest

Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.

Name Tipo Description Required Default
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No

OpenAI.Model

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

Name Tipo Description Required Default
created inteiro O carimbo de data/hora unix (em segundos) quando o modelo foi criado. Yes
id cadeia O identificador de modelo, que pode ser referenciado nos pontos de extremidade da API. Yes
objeto enumeração O tipo de objeto, que é sempre "model".
Valores possíveis: model		 Yes
owned_by cadeia A organização que possui o modelo. Yes

OpenAI.OtherChunkingStrategyResponseParam

Isso é retornado quando a estratégia de agrupamento é desconhecida. Normalmente, isso ocorre porque o arquivo foi indexado antes do 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 deseja habilitar a chamada de função paralela durante o uso da ferramenta.

Type: boolean

OpenAI.Prompt

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

Name Tipo Description Required Default
id cadeia O identificador exclusivo do modelo de prompt a ser usado. Yes
variables objeto Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. No
versão cadeia Versão opcional do modelo de prompt. No

OpenAI.RankingOptions

Name Tipo Description Required Default
classificador enumeração O classificador a ser usado para a pesquisa de arquivos.
Valores possíveis: auto, default-2024-11-15		 No
score_threshold number O limite de pontuação para a pesquisa de arquivos, um número entre 0 e 1. Números mais próximos de 1 tentarão retornar apenas os resultados mais relevantes, mas podem retornar menos resultados. No

OpenAI.Reasoning

somente modelos da série o

Name Tipo Description Required Default
Esforço objeto somente modelos da série o

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
generate_summary enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
resumo enumeração Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No

OpenAI.ReasoningEffort

somente modelos da série o

Restringe o esforço no raciocínio para modelos de raciocínio. Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.

Property Value
Description somente modelos da série o

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.
Type cadeia
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 esses itens na input API de Respostas para as próximas rodadas de uma conversa se você estiver gerenciando manualmente o contexto.

Name Tipo Description Required Default
encrypted_content cadeia O conteúdo criptografado do item de raciocínio - preenchido quando uma resposta é gerada no reasoning.encrypted_contentinclude parâmetro. No
resumo matriz Conteúdo de texto de raciocínio. Yes
tipo enumeração
Valores possíveis: reasoning		 Yes

OpenAI.ReasoningItemResource

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

Name Tipo Description Required Default
encrypted_content cadeia O conteúdo criptografado do item de raciocínio - preenchido quando uma resposta é gerada no reasoning.encrypted_contentinclude parâmetro. No
resumo matriz Conteúdo de texto de raciocínio. Yes
tipo enumeração
Valores possíveis: reasoning		 Yes

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Type Value Schema
summary_text OpenAI.ReasoningItemSummaryTextPart
Name Tipo Description Required Default
tipo OpenAI.ReasoningItemSummaryPartType Yes

OpenAI.ReasoningItemSummaryPartType

Property Value
Type cadeia
Values summary_text

OpenAI.ReasoningItemSummaryTextPart

Name Tipo Description Required Default
enviar SMS cadeia Yes
tipo enumeração
Valores possíveis: summary_text		 Yes

OpenAI.Response

Name Tipo Description Required Default
em segundo plano boolean Se a resposta do modelo deve ser executada em segundo plano. No False
created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. Yes
erro objeto Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. Yes
└─ code OpenAI.ResponseErrorCode O código de erro da resposta. No
└─ message cadeia Uma descrição legível pelo humano do erro. No
id cadeia Identificador exclusivo para esta resposta. Yes
incomplete_details objeto Detalhes sobre por que a resposta está incompleta. Yes
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
instructions cadeia de caracteres ou matriz Yes
max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
objeto enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 Yes
saída matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 Yes
output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. Yes True
previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
solicitação objeto Referência a um modelo de prompt e suas variáveis. No
└─ id cadeia O identificador exclusivo do modelo de prompt a ser usado. No
└─ variables OpenAI.ResponsePromptVariables Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos. No
└─ version cadeia Versão opcional do modelo de prompt. No
reasoning objeto somente modelos da série o

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

Restringe o esforço no raciocínio para modelos de raciocínio.
Os valores com suporte no momento são low, mediume high. A redução do esforço de raciocínio pode resultar em respostas mais rápidas e menos tokens usados no raciocínio em uma resposta.		 No
└─ generate_summary enumeração Preterido: use summary em vez disso.

Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
└─ summary enumeração Um resumo do raciocínio executado pelo modelo. Isso pode ser útil para depurar e entender o processo de raciocínio do modelo.
Um de auto, conciseou detailed.
Valores possíveis: auto, , concisedetailed		 No
status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 Yes
enviar SMS objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
tool_choice objeto Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

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

required significa que o modelo deve chamar uma ou mais ferramentas.		 No
└─ type OpenAI.ToolChoiceObjectType Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta. No
tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 Yes
truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
uso OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
usuário cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

Name Tipo Description Required Default
delta cadeia O snippet de código parcial que está sendo transmitido pelo interpretador de código. Yes
item_id cadeia O identificador exclusivo do item de chamada da ferramenta interpretador de código. Yes
output_index inteiro O índice do item de saída na resposta para a qual o código está sendo transmitido. Yes
tipo enumeração O tipo do evento. Sempre response.code_interpreter_call_code.delta.
Valores possíveis: response.code_interpreter_call_code.delta		 Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Emitido quando o snippet de código é finalizado pelo interpretador de código.

Name Tipo Description Required Default
codificar cadeia A saída final do snippet de código pelo interpretador de código. Yes
item_id cadeia O identificador exclusivo do item de chamada da ferramenta interpretador de código. Yes
output_index inteiro O índice do item de saída na resposta para a qual o código é finalizado. Yes
tipo enumeração O tipo do evento. Sempre response.code_interpreter_call_code.done.
Valores possíveis: response.code_interpreter_call_code.done		 Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Emitido quando a chamada do interpretador de código é concluída.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de chamada da ferramenta interpretador de código. Yes
output_index inteiro O índice do item de saída na resposta para a qual a chamada do interpretador de código é concluída. Yes
tipo enumeração O tipo do evento. Sempre response.code_interpreter_call.completed.
Valores possíveis: response.code_interpreter_call.completed		 Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Emitido quando uma chamada de interpretador de código está em andamento.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de chamada da ferramenta interpretador de código. Yes
output_index inteiro O índice do item de saída na resposta para a qual a chamada do interpretador de código está em andamento. Yes
tipo enumeração O tipo do evento. Sempre response.code_interpreter_call.in_progress.
Valores possíveis: response.code_interpreter_call.in_progress		 Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Emitido quando o interpretador de código está interpretando ativamente o snippet de código.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de chamada da ferramenta interpretador de código. Yes
output_index inteiro O índice do item de saída na resposta para a qual o interpretador de código está interpretando o código. Yes
tipo enumeração O tipo do evento. Sempre response.code_interpreter_call.interpreting.
Valores possíveis: response.code_interpreter_call.interpreting		 Yes

OpenAI.ResponseCompletedEvent

Emitido quando a resposta do modelo é concluída.

Name Tipo Description Required Default
response objeto Yes
└─ background boolean Se a resposta do modelo deve ser executada em segundo plano. No False
└─ created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. No
└─ id cadeia Identificador exclusivo para esta resposta. No
└─ incomplete_details objeto Detalhes sobre por que a resposta está incompleta. No
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions cadeia de caracteres ou matriz Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
└─ max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
└─ max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 No
└─ output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 No
└─ output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis. No
└─ reasoning OpenAI.Reasoning somente modelos da série o

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No
└─ text objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar. No
└─ tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
└─ top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
└─ user cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No
tipo enumeração O tipo do 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 inteiro O índice da parte de conteúdo que foi adicionada. Yes
item_id cadeia A ID do item de saída ao qual a parte de conteúdo foi adicionada. Yes
output_index inteiro O índice do item de saída ao qual a parte de conteúdo foi adicionada. Yes
part objeto Yes
└─ type OpenAI.ItemContentType Conteúdo de entrada e saída multi modal. No
tipo enumeração O tipo do evento. Sempre response.content_part.added.
Valores possíveis: response.content_part.added		 Yes

OpenAI.ResponseContentPartDoneEvent

Emitido quando uma parte do conteúdo é feita.

Name Tipo Description Required Default
content_index inteiro O índice da parte de conteúdo que é feita. Yes
item_id cadeia A ID do item de saída ao qual a parte de conteúdo foi adicionada. Yes
output_index inteiro O índice do item de saída ao qual a parte de conteúdo foi adicionada. Yes
part objeto Yes
└─ type OpenAI.ItemContentType Conteúdo de entrada e saída multi modal. No
tipo enumeração O tipo do evento. Sempre response.content_part.done.
Valores possíveis: response.content_part.done		 Yes

OpenAI.ResponseCreatedEvent

Um evento emitido quando uma resposta é criada.

Name Tipo Description Required Default
response objeto Yes
└─ background boolean Se a resposta do modelo deve ser executada em segundo plano. No False
└─ created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. No
└─ id cadeia Identificador exclusivo para esta resposta. No
└─ incomplete_details objeto Detalhes sobre por que a resposta está incompleta. No
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions cadeia de caracteres ou matriz Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
└─ max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
└─ max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 No
└─ output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 No
└─ output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis. No
└─ reasoning OpenAI.Reasoning somente modelos da série o

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O status da geração de resposta. Um de completed, failed
in_progress, cancelledou queuedincomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No
└─ text objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar. No
└─ tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
└─ top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
└─ user cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No
tipo enumeração O tipo do evento. Sempre response.created.
Valores possíveis: response.created		 Yes

OpenAI.ResponseError

Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta.

Name Tipo Description Required Default
codificar OpenAI.ResponseErrorCode O código de erro da resposta. Yes
mensagem cadeia Uma descrição legível pelo humano do erro. Yes

OpenAI.ResponseErrorCode

O código de erro da resposta.

Property Value
Description O código de erro da resposta.
Type cadeia
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
codificar cadeia O código de erro. Yes
mensagem cadeia A mensagem de erro. Yes
param cadeia O parâmetro de erro. Yes
tipo enumeração O tipo do evento. Sempre error.
Valores possíveis: error		 Yes

OpenAI.ResponseFailedEvent

Um evento emitido quando uma resposta falha.

Name Tipo Description Required Default
response objeto Yes
└─ background boolean Se a resposta do modelo deve ser executada em segundo plano. No False
└─ created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. No
└─ id cadeia Identificador exclusivo para esta resposta. No
└─ incomplete_details objeto Detalhes sobre por que a resposta está incompleta. No
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions cadeia de caracteres ou matriz Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
└─ max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
└─ max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 No
└─ output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 No
└─ output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis. No
└─ reasoning OpenAI.Reasoning somente modelos da série o

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No
└─ text objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar. No
└─ tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
└─ top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
└─ user cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No
tipo enumeração O tipo do evento. Sempre response.failed.
Valores possíveis: response.failed		 Yes

OpenAI.ResponseFileSearchCallCompletedEvent

Emitido quando uma chamada de pesquisa de arquivo é concluída (resultados encontrados).

Name Tipo Description Required Default
item_id cadeia A ID do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
output_index inteiro O índice do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
tipo enumeração O tipo do evento. Sempre response.file_search_call.completed.
Valores possíveis: response.file_search_call.completed		 Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Emitido quando uma chamada de pesquisa de arquivo é iniciada.

Name Tipo Description Required Default
item_id cadeia A ID do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
output_index inteiro O índice do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
tipo enumeração O tipo do evento. Sempre response.file_search_call.in_progress.
Valores possíveis: response.file_search_call.in_progress		 Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Emitido quando uma pesquisa de arquivo está pesquisando no momento.

Name Tipo Description Required Default
item_id cadeia A ID do item de saída que a chamada de pesquisa de arquivo é iniciada. Yes
output_index inteiro O índice do item de saída que a chamada de pesquisa de arquivo está pesquisando. Yes
tipo enumeração O tipo do evento. Sempre response.file_search_call.searching.
Valores possíveis: response.file_search_call.searching		 Yes

OpenAI.ResponseFormat

Discriminador para OpenAI.ResponseFormat

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

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_objectjson_schema		 Yes

OpenAI.ResponseFormatJsonObject

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

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

OpenAI.ResponseFormatJsonSchema

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

Name Tipo Description Required Default
json_schema objeto Opções de configuração de Saídas Estruturadas, incluindo um esquema JSON. Yes
└─ description cadeia Uma descrição do formato de resposta usado pelo modelo para determinar como responder no formato. No
└─ name cadeia O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64. No
└─ schema OpenAI.ResponseFormatJsonSchemaSchema O esquema para o formato de resposta, descrito como um objeto de esquema JSON.
Saiba como criar esquemas JSON aqui.		 No
└─ strict boolean Se deseja habilitar a adesão estrita do esquema ao gerar a saída.
Se definido como true, o modelo sempre seguirá o esquema exato definido no schema campo. Somente um subconjunto de esquema JSON tem suporte quando strict é true.		 No False
tipo enumeração O tipo de formato de resposta que está sendo definido. Sempre json_schema.
Valores possíveis: json_schema		 Yes

OpenAI.ResponseFormatJsonSchemaSchema

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

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á sendo definido. Sempre text.
Valores possíveis: text		 Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Emitido quando há um delta de argumentos parciais de chamada de função.

Name Tipo Description Required Default
delta cadeia O delta de argumentos de chamada de função que é adicionado. Yes
item_id cadeia A ID do item de saída ao qual o delta de argumentos de chamada de função é adicionado. Yes
output_index inteiro O índice do item de saída ao qual o delta de argumentos de chamada de função é adicionado. Yes
tipo enumeração O tipo do 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 Os argumentos de chamada de função. Yes
item_id cadeia A ID do item. Yes
output_index inteiro O índice do item de saída. Yes
tipo enumeração
Valores possíveis: response.function_call_arguments.done		 Yes

OpenAI.ResponseImageGenCallCompletedEvent

Emitido quando uma chamada de ferramenta de geração de imagem é concluída e a imagem final está disponível.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do 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á gerando ativamente uma imagem (estado intermediário).

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do evento. Always 'response.image_generation_call.generating'.
Valores possíveis: response.image_generation_call.generating		 Yes

OpenAI.ResponseImageGenCallInProgressEvent

Emitido quando uma chamada de ferramenta de geração de imagem está em andamento.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do evento. Always 'response.image_generation_call.in_progress'.
Valores possíveis: response.image_generation_call.in_progress		 Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Emitido quando uma imagem parcial está disponível durante o streaming de geração de imagem.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de geração de imagem que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
partial_image_b64 cadeia Dados de imagem parciais codificados em Base64, adequados para renderização como uma imagem. Yes
partial_image_index inteiro Índice baseado em 0 para a imagem parcial (o back-end é baseado em 1, mas é baseado em 0 para o usuário). Yes
tipo enumeração O tipo do 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 objeto Yes
└─ background boolean Se a resposta do modelo deve ser executada em segundo plano. No False
└─ created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. No
└─ id cadeia Identificador exclusivo para esta resposta. No
└─ incomplete_details objeto Detalhes sobre por que a resposta está incompleta. No
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions cadeia de caracteres ou matriz Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
└─ max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
└─ max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 No
└─ output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 No
└─ output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis. No
└─ reasoning OpenAI.Reasoning somente modelos da série o

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No
└─ text objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar. No
└─ tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
└─ top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
└─ user cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No
tipo enumeração O tipo do evento. Sempre response.in_progress.
Valores possíveis: response.in_progress		 Yes

OpenAI.ResponseIncompleteEvent

Um evento emitido quando uma resposta é concluída como incompleta.

Name Tipo Description Required Default
response objeto Yes
└─ background boolean Se a resposta do modelo deve ser executada em segundo plano. No False
└─ created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. No
└─ id cadeia Identificador exclusivo para esta resposta. No
└─ incomplete_details objeto Detalhes sobre por que a resposta está incompleta. No
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions cadeia de caracteres ou matriz Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
└─ max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
└─ max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 No
└─ output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 No
└─ output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis. No
└─ reasoning OpenAI.Reasoning somente modelos da série o

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No
└─ text objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar. No
└─ tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
└─ top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
└─ user cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No
tipo enumeração O tipo do 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 de itens usados para gerar essa resposta. Yes
first_id cadeia A ID do primeiro item da lista. Yes
has_more boolean Se há mais itens disponíveis. Yes
last_id cadeia A ID do último item da lista. Yes
objeto enumeração O tipo de objeto retornado deve ser list.
Valores possíveis: list		 Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Emitido quando há um delta (atualização parcial) para os argumentos de uma chamada de ferramenta MCP.

Name Tipo Description Required Default
delta A atualização parcial para os argumentos da chamada da ferramenta MCP. Yes
item_id cadeia O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do evento. Always 'response.mcp_call.arguments_delta'.
Valores possíveis: response.mcp_call.arguments_delta		 Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Emitido quando os argumentos de uma chamada de ferramenta MCP são finalizados.

Name Tipo Description Required Default
arguments Os argumentos finalizados para a chamada da ferramenta MCP. Yes
item_id cadeia O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do 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 êxito.

Name Tipo Description Required Default
tipo enumeração O tipo do evento. Always 'response.mcp_call.completed'.
Valores possíveis: response.mcp_call.completed		 Yes

OpenAI.ResponseMCPCallFailedEvent

Emitido quando uma chamada de ferramenta MCP falha.

Name Tipo Description Required Default
tipo enumeração O tipo do 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 andamento.

Name Tipo Description Required Default
item_id cadeia O identificador exclusivo do item de chamada da ferramenta MCP que está sendo processado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do 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 êxito.

Name Tipo Description Required Default
tipo enumeração O tipo do 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 do evento. Always 'response.mcp_list_tools.failed'.
Valores possíveis: response.mcp_list_tools.failed		 Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Emitido quando o sistema está no processo de recuperação da lista de ferramentas MCP disponíveis.

Name Tipo Description Required Default
tipo enumeração O tipo do 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 objeto Item de conteúdo usado para gerar uma resposta. Yes
└─ id cadeia No
└─ type OpenAI.ItemType No
output_index inteiro O índice do item de saída que foi adicionado. Yes
tipo enumeração O tipo do 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 objeto Item de conteúdo usado para gerar uma resposta. Yes
└─ id cadeia No
└─ type OpenAI.ItemType No
output_index inteiro O índice do item de saída que foi marcado como concluído. Yes
tipo enumeração O tipo do evento. Sempre response.output_item.done.
Valores possíveis: response.output_item.done		 Yes

OpenAI.ResponsePromptVariables

Mapa opcional de valores a serem substituídos por variáveis em seu prompt. Os valores de substituição podem ser cadeias de caracteres ou outros tipos de entrada de resposta, como imagens ou arquivos.

Type: object

OpenAI.ResponseQueuedEvent

Emitido quando uma resposta é enfileirada e aguardando para ser processada.

Name Tipo Description Required Default
response objeto Yes
└─ background boolean Se a resposta do modelo deve ser executada em segundo plano. No False
└─ created_at inteiro Unix timestamp (em segundos) de quando esta Resposta foi criada. No
└─ error OpenAI.ResponseError Um objeto de erro retornado quando o modelo falha ao gerar uma Resposta. No
└─ id cadeia Identificador exclusivo para esta resposta. No
└─ incomplete_details objeto Detalhes sobre por que a resposta está incompleta. No
└─ reason enumeração O motivo pelo qual a resposta está incompleta.
Valores possíveis: max_output_tokens, content_filter		 No
└─ instructions cadeia de caracteres ou matriz Uma mensagem do sistema (ou desenvolvedor) inserida no contexto do modelo.

Ao usar junto com previous_response_id, as instruções de uma resposta anterior não serão levadas para a próxima resposta. Isso simplifica a troca de mensagens do sistema (ou do desenvolvedor) em novas respostas.		 No
└─ max_output_tokens inteiro Um limite superior para o número de tokens que podem ser gerados para uma resposta, incluindo tokens de saída visíveis e tokens de raciocínio No
└─ max_tool_calls inteiro O número máximo de chamadas totais para ferramentas internas que podem ser processadas em uma resposta. Esse número máximo se aplica a todas as chamadas de ferramenta internas, não por ferramenta individual. Todas as outras tentativas de chamar uma ferramenta pelo modelo serão ignoradas. No
└─ metadata objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
└─ object enumeração O tipo de objeto desse recurso – sempre definido como response.
Valores possíveis: response		 No
└─ output matriz Uma matriz de itens de conteúdo gerados pelo modelo.

- O comprimento e a ordem dos itens na output matriz dependem da resposta do modelo.
- Em vez de acessar o primeiro item na output matriz e supondo que seja uma assistant mensagem com o conteúdo gerado pelo modelo, você pode considerar usar a output_text propriedade em que há suporte em SDKs.		 No
└─ output_text cadeia Propriedade de conveniência somente SDK que contém a saída de texto agregada de todos os output_text itens na output matriz, se houver algum.
Com suporte nos SDKs Python e JavaScript.		 No
└─ parallel_tool_calls boolean Se deseja permitir que o modelo execute chamadas de ferramenta em paralelo. No True
└─ previous_response_id cadeia A ID exclusiva da resposta anterior ao modelo. Use isso para criar conversas de vários turnos. No
└─ prompt OpenAI.Prompt Referência a um modelo de prompt e suas variáveis. No
└─ reasoning OpenAI.Reasoning somente modelos da série o

Opções de configuração para modelos de raciocínio.		 No
└─ status enumeração O status da geração de resposta. Um de completed, failed, in_progress, , cancelled, queuedou incomplete.
Valores possíveis: completed, , failed, in_progress, cancelled, , queuedincomplete		 No
└─ temperature number Que temperatura de amostragem usar, entre 0 e 2. Valores mais altos, como 0,8, tornarão a saída mais aleatória, enquanto valores mais baixos como 0,2 o tornarão mais focado e determinístico.
Geralmente, recomendamos alterar isso ou top_p não ambos.		 No
└─ text objeto Opções de configuração para uma resposta de texto do modelo. Pode ser texto sem formatação ou dados JSON estruturados. No
└─ format OpenAI.ResponseTextFormatConfiguration No
└─ tool_choice OpenAI.ToolChoiceOptions ou OpenAI.ToolChoiceObject Como o modelo deve selecionar qual ferramenta (ou ferramentas) usar ao gerar uma resposta. Consulte o tools parâmetro para ver como especificar quais ferramentas o modelo pode chamar. No
└─ tools matriz Uma matriz de ferramentas que o modelo pode chamar ao gerar uma resposta. Você pode especificar qual ferramenta usar definindo o tool_choice parâmetro.

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

- Ferramentas internas: ferramentas fornecidas pelo OpenAI que estendem os recursos do modelo.		 No
└─ top_logprobs inteiro Um inteiro entre 0 e 20 especificando o número de tokens mais prováveis a serem retornados em cada posição de token, cada um com uma probabilidade de log associada. No
└─ top_p number Uma alternativa à amostragem com temperatura, chamada amostragem de núcleo, em que o modelo considera os resultados dos tokens com top_p massa de probabilidade. Portanto, 0.1 significa que somente os tokens que compõem a massa de probabilidade de 10% principais são considerados.

Geralmente, recomendamos alterar isso ou temperature não ambos.		 No
└─ truncation enumeração A estratégia de truncamento a ser usada para a resposta do modelo.
- auto: se o contexto dessa resposta e os anteriores excederem o tamanho da janela de contexto do modelo, o modelo truncará a resposta para se ajustar à janela de contexto soltando itens de entrada no meio da conversa.
- disabled (padrão): se uma resposta de modelo exceder o tamanho da janela de contexto de um modelo, a solicitação falhará com um erro 400.
Valores possíveis: auto, disabled		 No
└─ usage OpenAI.ResponseUsage Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados. No
└─ user cadeia Um identificador exclusivo que representa o usuário final, que pode ajudar o OpenAI a monitorar e detectar abusos. No
tipo enumeração O tipo do 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 inteiro O índice da parte de conteúdo de raciocínio dentro do item de saída. Yes
delta A atualização parcial para o conteúdo de raciocínio. Yes
item_id cadeia O identificador exclusivo do item para o qual o raciocínio está sendo atualizado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
tipo enumeração O tipo do evento. Always 'response.reasoning.delta'.
Valores possíveis: response.reasoning.delta		 Yes

OpenAI.ResponseReasoningDoneEvent

Emitido quando o conteúdo do raciocínio é finalizado para um item.

Name Tipo Description Required Default
content_index inteiro O índice da parte de conteúdo de raciocínio dentro do item de saída. Yes
item_id cadeia O identificador exclusivo do item para o qual o raciocínio é finalizado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
enviar SMS cadeia O texto de raciocínio finalizado. Yes
tipo enumeração O tipo do evento. Always 'response.reasoning.done'.
Valores possíveis: response.reasoning.done		 Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

Emitido quando há um delta (atualização parcial) no conteúdo de resumo do raciocínio.

Name Tipo Description Required Default
delta A atualização parcial para o conteúdo de resumo do raciocínio. Yes
item_id cadeia O identificador exclusivo do item para o qual o resumo do raciocínio está sendo atualizado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
summary_index inteiro O índice da parte de resumo dentro do item de saída. Yes
tipo enumeração O tipo do 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 O identificador exclusivo do item para o qual o resumo do raciocínio é finalizado. Yes
output_index inteiro O índice do item de saída na matriz de saída da resposta. Yes
summary_index inteiro O índice da parte de resumo dentro do item de saída. Yes
enviar SMS cadeia O texto de resumo do raciocínio finalizado. Yes
tipo enumeração O tipo do 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 A ID do item à qual essa parte de resumo está associada. Yes
output_index inteiro O índice do item de saída ao qual essa parte de resumo está associada. Yes
part objeto Yes
└─ type OpenAI.ReasoningItemSummaryPartType No
summary_index inteiro O índice da parte de resumo dentro do resumo do raciocínio. Yes
tipo enumeração O tipo do evento. Sempre response.reasoning_summary_part.added.
Valores possíveis: response.reasoning_summary_part.added		 Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Emitido quando uma parte de resumo de raciocínio é concluída.

Name Tipo Description Required Default
item_id cadeia A ID do item à qual essa parte de resumo está associada. Yes
output_index inteiro O índice do item de saída ao qual essa parte de resumo está associada. Yes
part objeto Yes
└─ type OpenAI.ReasoningItemSummaryPartType No
summary_index inteiro O índice da parte de resumo dentro do resumo do raciocínio. Yes
tipo enumeração O tipo do evento. Sempre response.reasoning_summary_part.done.
Valores possíveis: response.reasoning_summary_part.done		 Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Emitido quando um delta é adicionado a um texto de resumo de raciocínio.

Name Tipo Description Required Default
delta cadeia O delta de texto que foi adicionado ao resumo. Yes
item_id cadeia A ID do item ao qual este delta de texto de resumo está associado. Yes
output_index inteiro O índice do item de saída ao qual este delta de texto de resumo está associado. Yes
summary_index inteiro O índice da parte de resumo dentro do resumo do raciocínio. Yes
tipo enumeração O tipo do evento. Sempre response.reasoning_summary_text.delta.
Valores possíveis: response.reasoning_summary_text.delta		 Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Emitido quando um texto de resumo de raciocínio é concluído.

Name Tipo Description Required Default
item_id cadeia A ID do item ao qual este texto de resumo está associado. Yes
output_index inteiro O índice do item de saída ao qual este texto de resumo está associado. Yes
summary_index inteiro O índice da parte de resumo dentro do resumo do raciocínio. Yes
enviar SMS cadeia O texto completo do resumo do raciocínio concluído. Yes
tipo enumeração O tipo do 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 inteiro O índice da parte de conteúdo à qual o texto de recusa é adicionado. Yes
delta cadeia O texto de recusa que é adicionado. Yes
item_id cadeia A ID do item de saída ao qual o texto de recusa é adicionado. Yes
output_index inteiro O índice do item de saída ao qual o texto de recusa é adicionado. Yes
tipo enumeração O tipo do 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 inteiro O índice da parte de conteúdo que o texto de recusa é finalizado. Yes
item_id cadeia A ID do item de saída em que o texto de recusa é finalizado. Yes
output_index inteiro O índice do item de saída em que o texto de recusa é finalizado. Yes
refusal cadeia O texto de recusa finalizado. Yes
tipo enumeração O tipo do evento. Sempre response.refusal.done.
Valores possíveis: response.refusal.done		 Yes

OpenAI.ResponseStreamEvent

Discriminador para OpenAI.ResponseStreamEvent

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

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

OpenAI.ResponseStreamEventType

Property Value
Type cadeia
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 de texto adicional.

Name Tipo Description Required Default
content_index inteiro O índice da parte de conteúdo à qual o delta de texto foi adicionado. Yes
delta cadeia O delta de texto que foi adicionado. Yes
item_id cadeia A ID do item de saída ao qual o delta de texto foi adicionado. Yes
output_index inteiro O índice do item de saída ao qual o delta de texto foi adicionado. Yes
tipo enumeração O tipo do evento. Sempre response.output_text.delta.
Valores possíveis: response.output_text.delta		 Yes

OpenAI.ResponseTextDoneEvent

Emitido quando o conteúdo do texto é finalizado.

Name Tipo Description Required Default
content_index inteiro O índice da parte de conteúdo que o conteúdo do texto é finalizado. Yes
item_id cadeia A ID do item de saída em que o conteúdo do texto é finalizado. Yes
output_index inteiro O índice do item de saída que o conteúdo do texto é finalizado. Yes
enviar SMS cadeia O conteúdo do texto finalizado. Yes
tipo enumeração O tipo do evento. Sempre response.output_text.done.
Valores possíveis: response.output_text.done		 Yes

OpenAI.ResponseTextFormatConfiguration

Discriminatório para OpenAI.ResponseTextFormatConfiguration

Esse componente usa 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" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido. O formato padrão não tem { "type": "text" } opções adicionais.

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

A configuração para { "type": "json_object" } habilitar o modo JSON mais antigo, o que garante que a mensagem gerada pelo modelo seja JSON válida. O uso json_schema é preferencial para modelos que dão suporte a ele.		 Yes

OpenAI.ResponseTextFormatConfigurationJsonObject

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

OpenAI.ResponseTextFormatConfigurationJsonSchema

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

Name Tipo Description Required Default
description cadeia Uma descrição do formato de resposta usado pelo modelo para determinar como responder no formato. No
name cadeia O nome do formato de resposta. Deve ser a-z, A-Z, 0-9 ou conter sublinhados e traços, com um comprimento máximo de 64. Yes
esquema OpenAI.ResponseFormatJsonSchemaSchema O esquema para o formato de resposta, descrito como um objeto de esquema JSON.
Saiba como criar esquemas JSON aqui.		 Yes
strict boolean Se deseja habilitar a adesão estrita do esquema ao gerar a saída.
Se definido como true, o modelo sempre seguirá o esquema exato definido no schema campo. Somente um subconjunto de esquema JSON tem suporte quando strict é true.		 No False
tipo enumeração O tipo de formato de resposta que está sendo 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" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido.

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

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

A configuração para { "type": "json_object" } habilitar o modo JSON mais antigo, o que garante que a mensagem gerada pelo modelo seja JSON válida. O uso json_schema é preferencial para modelos que dão suporte a ele.

Property Value
Description Um objeto que especifica o formato que o modelo deve gerar.

A configuração { "type": "json_schema" } habilita saídas estruturadas, o que garante que o modelo corresponda ao esquema JSON fornecido.

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

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

A configuração para { "type": "json_object" } habilitar o modo JSON mais antigo, o que garante que a mensagem gerada pelo modelo seja JSON válida. O uso json_schemaé preferencial para modelos que dão suporte a ele.

OpenAI.ResponseUsage

Representa os detalhes de uso do token, incluindo tokens de entrada, tokens de saída, uma divisão de tokens de saída e o total de tokens usados.

Name Tipo Description Required Default
input_tokens inteiro O número de tokens de entrada. Yes
input_tokens_details objeto Um detalhamento dos tokens de entrada. Yes
└─ cached_tokens inteiro O número de tokens recuperados do cache. No
output_tokens inteiro O número de tokens de saída. Yes
output_tokens_details objeto Um detalhamento dos tokens de saída. Yes
└─ reasoning_tokens inteiro O número de tokens de raciocínio. No
total_tokens inteiro O número total de tokens usados. Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Observação: web_search ainda não está disponível via Azure OpenAI.

Name Tipo Description Required Default
item_id cadeia ID exclusiva para o item de saída associado à chamada de pesquisa na Web. Yes
output_index inteiro O índice do item de saída ao qual a chamada de pesquisa na Web está associada. Yes
tipo enumeração O tipo do evento. Sempre response.web_search_call.completed.
Valores possíveis: response.web_search_call.completed		 Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Observação: web_search ainda não está disponível via Azure OpenAI.

Name Tipo Description Required Default
item_id cadeia ID exclusiva para o item de saída associado à chamada de pesquisa na Web. Yes
output_index inteiro O índice do item de saída ao qual a chamada de pesquisa na Web está associada. Yes
tipo enumeração O tipo do evento. Sempre response.web_search_call.in_progress.
Valores possíveis: response.web_search_call.in_progress		 Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Observação: web_search ainda não está disponível via Azure OpenAI.

Name Tipo Description Required Default
item_id cadeia ID exclusiva para o item de saída associado à chamada de pesquisa na Web. Yes
output_index inteiro O índice do item de saída ao qual a chamada de pesquisa na Web está associada. Yes
tipo enumeração O tipo do evento. Sempre response.web_search_call.searching.
Valores possíveis: response.web_search_call.searching		 Yes

OpenAI.ResponsesAssistantMessageItemParam

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

Name Tipo Description Required Default
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração A função da mensagem, que é sempre assistant.
Valores possíveis: assistant		 Yes

OpenAI.ResponsesAssistantMessageItemResource

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

Name Tipo Description Required Default
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração A função da mensagem, que é sempre assistant.
Valores possíveis: assistant		 Yes

OpenAI.ResponsesDeveloperMessageItemParam

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

Name Tipo Description Required Default
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração A função da mensagem, que é sempre developer.
Valores possíveis: developer		 Yes

OpenAI.ResponsesDeveloperMessageItemResource

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

Name Tipo Description Required Default
conteúdo matriz O conteúdo associado à mensagem. Yes
função enumeração A função da mensagem, que é sempre developer.
Valores possíveis: developer		 Yes

OpenAI.ResponsesMessageItemParam

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

Discriminador para OpenAI.ResponsesMessageItemParam

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

Type Value Schema
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
Name Tipo Description Required Default
função objeto A coleção de funções válidas para itens de mensagem de respostas. Yes
tipo enumeração O tipo do item de respostas, que é sempre "mensagem".
Valores possíveis: message		 Yes

OpenAI.ResponsesMessageItemResource

Um item de recurso de mensagem de resposta, que representa uma função e um conteúdo, conforme fornecido nas respostas do serviço.

Discriminador para OpenAI.ResponsesMessageItemResource

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

Type Value Schema
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
Name Tipo Description Required Default
função objeto A coleção de funções válidas para itens de mensagem de respostas. Yes
status enumeração O status do item. Um de in_progress, completedou incomplete. Populado quando os itens são retornados por meio da API.
Valores possíveis: in_progress, , completedincomplete		 Yes
tipo enumeração O tipo do item de respostas, que é sempre "mensagem".
Valores possíveis: message		 Yes

OpenAI.ResponsesMessageRole

A coleção de funções válidas para itens de mensagem de respostas.

Property Value
Description A coleção de funções válidas para itens de mensagem de respostas.
Type cadeia
Values system
developer
user
assistant

OpenAI.ResponsesSystemMessageItemParam

Um item de parâmetro 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 A função 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 A função da mensagem, que é sempre system.
Valores possíveis: system		 Yes

OpenAI.ResponsesUserMessageItemParam

Um item de parâmetro 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 A função 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 A função da mensagem, que é sempre user.
Valores possíveis: user		 Yes

OpenAI.RunGraderRequest

Name Tipo Description Required Default
grader objeto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. No
└─ evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 No
└─ graders objeto No
└─ image_tag cadeia A marca de imagem a ser usada para o script python. No
└─ input matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. No
└─ model cadeia O modelo a ser usado para a avaliação. No
└─ name cadeia O nome do classificador. No
└─ operation enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 No
└─ range matriz O intervalo da pontuação. O padrão é [0, 1]. No
└─ reference cadeia O texto que está sendo classificado. No
└─ sampling_params Os parâmetros de amostragem do modelo. No
└─ source cadeia 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 de conjunto de dados fornecido ao classificador. Isso será usado para preencher o item namespace. No
model_sample cadeia O exemplo de modelo a ser avaliado. Esse valor será usado para preencher o sample namespace.
A output_json variável será preenchida se o exemplo de modelo for uma cadeia de caracteres JSON válida.		 Yes

OpenAI.RunGraderResponse

Name Tipo Description Required Default
metadados objeto Yes
└─ errors objeto 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 No
└─ other_error boolean No
└─ python_grader_runtime_error boolean No
└─ python_grader_runtime_error_details cadeia No
└─ python_grader_server_error boolean No
└─ python_grader_server_error_type cadeia No
└─ sample_parse_error boolean No
└─ truncated_observation_error boolean No
└─ unresponsive_reward_error boolean No
└─ execution_time number No
└─ name cadeia No
└─ sampled_model_name cadeia No
└─ scores No
└─ token_usage inteiro No
└─ type cadeia No
model_grader_token_usage_per_model Yes
reward number Yes
sub_rewards Yes

OpenAI.StaticChunkingStrategy

Name Tipo Description Required Default
chunk_overlap_tokens inteiro O número de tokens que se sobrepõem entre partes. O valor padrão é 400.

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

OpenAI.StaticChunkingStrategyRequestParam

Personalize sua própria estratégia de agrupamento definindo o tamanho da parte e a sobreposição de partes.

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 há suporte para modelos o3 de raciocínio mais recentes e o4-mini.

Até 4 sequências em que a API deixará de gerar tokens adicionais. O texto retornado não conterá a sequência de interrupção.

Esse esquema aceita um dos seguintes tipos:

  • string
  • array

OpenAI.Tool

Discriminador para OpenAI.Tool

Esse componente usa 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

Esse componente usa 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 interna 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 essa opção para forçar o modelo a chamar uma função específica.

Name Tipo Description Required Default
name cadeia O nome da função a ser chamada. Yes
tipo enumeração Para a chamada de função, o tipo é sempre function.
Valores possíveis: function		 Yes

OpenAI.ToolChoiceObjectImageGen

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

OpenAI.ToolChoiceObjectMCP

Use essa opção para forçar o modelo a chamar uma ferramenta específica em um servidor MCP remoto.

Name Tipo Description Required Default
name cadeia O nome da ferramenta a ser chamada no servidor. No
server_label cadeia O rótulo do servidor MCP a ser usado. Yes
tipo enumeração Para ferramentas MCP, o tipo é sempre mcp.
Valores possíveis: mcp		 Yes

OpenAI.ToolChoiceObjectType

Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.

Property Value
Description Indica que o modelo deve usar uma ferramenta interna para gerar uma resposta.
Type cadeia
Values file_search
function
computer_use_preview
web_search_preview
image_generation
code_interpreter
mcp

OpenAI.ToolChoiceObjectWebSearch

Observação: web_search ainda não está disponível via Azure OpenAI.

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

OpenAI.ToolChoiceOptions

Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

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

required significa que o modelo deve chamar uma ou mais ferramentas.

Property Value
Description Controla qual ferramenta (se houver) é chamada pelo modelo.

none significa que o modelo não chamará nenhuma ferramenta e, em vez disso, gerará uma mensagem.

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

required significa que o modelo deve chamar uma ou mais ferramentas.
Type cadeia
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
Values file_search
function
computer_use_preview
web_search_preview
mcp
code_interpreter
image_generation
local_shell

OpenAI.TopLogProb

A probabilidade de log superior de um token.

Name Tipo Description Required Default
bytes matriz Yes
logprob number Yes
símbolo cadeia Yes

OpenAI.TranscriptionAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property Value
Type cadeia
Values logprobs

OpenAI.TranscriptionSegment

Name Tipo Description Required Default
avg_logprob number Logprob médio do segmento. Se o valor for menor que -1, considere que os logprobs falharam. Yes
compression_ratio number Taxa de compactação do segmento. Se o valor for maior que 2,4, considere a compactação com falha. Yes
end number Hora de término do segmento em segundos. Yes
id inteiro Identificador exclusivo do segmento. Yes
no_speech_prob number Probabilidade de nenhuma fala no segmento. Se o valor for maior que 1,0 e estiver avg_logprob abaixo de -1, considere esse segmento silencioso. Yes
seek inteiro Buscar deslocamento do segmento. Yes
start number Hora de início do segmento em segundos. Yes
temperature number Parâmetro de temperatura usado para gerar o segmento. Yes
enviar SMS cadeia Conteúdo de texto do segmento. Yes
tokens matriz Matriz de IDs de token para o conteúdo do texto. Yes

OpenAI.TranscriptionWord

Name Tipo Description Required Default
end number Hora de término da palavra em segundos. Yes
start number Hora de início da palavra em segundos. Yes
palavra cadeia O conteúdo do texto da palavra. Yes

OpenAI.TranslationAudioResponseFormat

References: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

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

OpenAI.UpdateVectorStoreRequest

Name Tipo Description Required Default
expires_after objeto A política de expiração de um repositório de vetores. No
└─ anchor enumeração Carimbo de data/hora de âncora após o qual a política de expiração se aplica. Âncoras com suporte: last_active_at.
Valores possíveis: last_active_at		 No
└─ days inteiro O número de dias após o tempo de ancoragem em que o repositório de vetores expirará. No
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 No
name cadeia O nome do repositório de vetores. No

OpenAI.VadConfig

Name Tipo Description Required Default
prefix_padding_ms inteiro Quantidade de áudio a ser incluída antes da fala detectada pelo VAD (em milissegundos). No 300
silence_duration_ms inteiro Duração do silêncio para detectar a parada de fala (em milissegundos).
Com valores mais curtos, o modelo responderá mais rapidamente, mas pode entrar em pausas curtas do usuário.		 No 200
limite number Limite de confidencialidade (0,0 a 1,0) para detecção de atividade de voz. Um limite mais alto exigirá um áudio mais alto para ativar o modelo e, portanto, poderá ter um desempenho melhor em ambientes barulhentos. No 0.5
tipo enumeração Deve ser definido para server_vad habilitar o agrupamento manual usando o VAD do lado do servidor.
Valores possíveis: server_vad		 Yes

OpenAI.ValidateGraderRequest

Name Tipo Description Required Default
grader objeto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. Yes
└─ calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. No
└─ evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 No
└─ graders objeto No
└─ image_tag cadeia A marca de imagem a ser usada para o script python. No
└─ input matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. No
└─ model cadeia O modelo a ser usado para a avaliação. No
└─ name cadeia O nome do classificador. No
└─ operation enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 No
└─ range matriz O intervalo da pontuação. O padrão é [0, 1]. No
└─ reference cadeia O texto que está sendo classificado. No
└─ sampling_params Os parâmetros de amostragem do modelo. No
└─ source cadeia 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 objeto Um objeto StringCheckGrader que executa uma comparação de cadeia de caracteres entre entrada e referência usando uma operação especificada. No
└─ calculate_output cadeia Uma fórmula para calcular a saída com base nos resultados do classificador. No
└─ evaluation_metric enumeração A métrica de avaliação a ser usada. Um de fuzzy_match, , bleugleu, , meteor, rouge_1, rouge_2, rouge_3, rouge_4, , rouge_5ou rouge_l.
Valores possíveis: fuzzy_match, , bleu, gleu, meteor, rouge_1, rouge_2, , rouge_3, rouge_4, , , , rouge_5rouge_l		 No
└─ graders objeto No
└─ image_tag cadeia A marca de imagem a ser usada para o script python. No
└─ input matriz O texto de entrada. Isso pode incluir cadeias de caracteres de modelo. No
└─ model cadeia O modelo a ser usado para a avaliação. No
└─ name cadeia O nome do classificador. No
└─ operation enumeração A operação de verificação de cadeia de caracteres a ser executada. Um de eq, ne, likeou ilike.
Valores possíveis: eq, , ne, likeilike		 No
└─ range matriz O intervalo da pontuação. O padrão é [0, 1]. No
└─ reference cadeia O texto que está sendo classificado. No
└─ sampling_params Os parâmetros de amostragem do modelo. No
└─ source cadeia 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 de um repositório de vetores.

Name Tipo Description Required Default
âncora enumeração Carimbo de data/hora de âncora após o qual a política de expiração se aplica. Âncoras com suporte: last_active_at.
Valores possíveis: last_active_at		 Yes
days inteiro O número de dias após o tempo de ancoragem em que o repositório de vetores expirará. Yes

OpenAI.VectorStoreFileAttributes

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

Type: object

OpenAI.VectorStoreFileBatchObject

Um lote de arquivos anexados a um repositório de vetores.

Name Tipo Description Required Default
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando o lote de arquivos do repositório de vetores foi criado. Yes
file_counts objeto Yes
└─ cancelled inteiro O número de arquivos que foram cancelados. No
└─ completed inteiro O número de arquivos que foram processados. No
└─ failed inteiro O número de arquivos que falharam ao processar. No
└─ in_progress inteiro O número de arquivos que estão sendo processados no momento. No
└─ total inteiro O número total de arquivos. No
id cadeia O identificador, que pode ser referenciado em pontos de extremidade de API. Yes
objeto enumeração O tipo de objeto, que é sempre vector_store.file_batch.
Valores possíveis: vector_store.files_batch		 Yes
status enumeração O status do lote de arquivos do repositório de vetores, que pode ser in_progress, completedcancelled ou failed.
Valores possíveis: in_progress, , completed, cancelledfailed		 Yes
vector_store_id cadeia A ID do repositório de vetores ao qual o arquivo está anexado. Yes

OpenAI.VectorStoreFileObject

Uma lista de arquivos anexados a um repositório de vetores.

Name Tipo Description Required Default
attributes objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel. As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres, boolianos ou números. No
chunking_strategy objeto No
└─ type enumeração
Valores possíveis: static, other		 No
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando o arquivo de repositório de vetores foi criado. Yes
id cadeia O identificador, que pode ser referenciado em pontos de extremidade de API. Yes
last_error objeto O último erro associado a esse arquivo de repositório de vetores. 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_fileinvalid_file		 No
└─ message cadeia Uma descrição legível pelo humano do erro. No
objeto enumeração O tipo de objeto, que é sempre vector_store.file.
Valores possíveis: vector_store.file		 Yes
status enumeração O status do arquivo de repositório de vetores, que pode ser in_progress, , completedou cancelledfailed. O status completed indica que o arquivo de repositório de vetores está pronto para uso.
Valores possíveis: in_progress, , completed, cancelledfailed		 Yes
usage_bytes inteiro O uso total do repositório de vetores em bytes. Observe que isso pode ser diferente do tamanho do arquivo original. Yes
vector_store_id cadeia A ID do repositório de vetores ao qual o arquivo está anexado. Yes

OpenAI.VectorStoreObject

Um repositório de vetores é uma coleção de arquivos processados que podem ser usados pela file_search ferramenta.

Name Tipo Description Required Default
created_at inteiro O carimbo de data/hora Unix (em segundos) para quando o repositório de vetores foi criado. Yes
expires_after OpenAI.VectorStoreExpirationAfter A política de expiração de um repositório de vetores. No
expires_at inteiro O carimbo de data/hora Unix (em segundos) para quando o repositório de vetores expirará. No
file_counts objeto Yes
└─ cancelled inteiro O número de arquivos que foram cancelados. No
└─ completed inteiro O número de arquivos que foram processados com êxito. No
└─ failed inteiro O número de arquivos que falharam ao processar. No
└─ in_progress inteiro O número de arquivos que estão sendo processados no momento. No
└─ total inteiro O número total de arquivos. No
id cadeia O identificador, que pode ser referenciado em pontos de extremidade de API. Yes
last_active_at inteiro O carimbo de data/hora Unix (em segundos) para quando o repositório de vetores estava ativo pela última vez. Yes
metadados objeto Conjunto de 16 pares chave-valor que podem ser anexados a um objeto. Isso pode ser útil para armazenar informações adicionais sobre o objeto em um formato estruturado e consultar objetos por meio da API ou do painel.

As chaves são cadeias de caracteres com um comprimento máximo de 64 caracteres. Os valores são cadeias de caracteres com um comprimento máximo de 512 caracteres.		 Yes
name cadeia O nome do repositório de vetores. Yes
objeto enumeração O tipo de objeto, que é sempre vector_store.
Valores possíveis: vector_store		 Yes
status enumeração O status do repositório de vetores, que pode ser expired, in_progressou completed. Um status indica completed que o repositório de vetores está pronto para uso.
Valores possíveis: expired, , in_progresscompleted		 Yes
usage_bytes inteiro O número total de bytes usados pelos arquivos no repositório de vetores. Yes

OpenAI.VoiceIdsShared

Property Value
Type cadeia
Values alloy
ash
ballad
coral
echo
fable
onyx
nova
sage
shimmer
verse

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

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 "localizar": pesquisa um padrão em uma página carregada.

Name Tipo Description Required Default
padrão cadeia O padrão ou texto a ser pesquisado dentro da página. Yes
tipo enumeração O tipo de ação.
Valores possíveis: find		 Yes
url cadeia A URL da página pesquisou o padrão. Yes

OpenAI.WebSearchActionOpenPage

Tipo de ação "open_page" – abre uma URL específica dos resultados da pesquisa.

Name Tipo Description Required Default
tipo enumeração O tipo de ação.
Valores possíveis: open_page		 Yes
url cadeia A URL aberta pelo modelo. Yes

OpenAI.WebSearchActionSearch

Tipo de ação "pesquisa" – executa uma consulta de pesquisa na Web.

Name Tipo Description Required Default
consulta cadeia A consulta de pesquisa. Yes
tipo enumeração O tipo de ação.
Valores possíveis: search		 Yes

OpenAI.WebSearchActionType

Property Value
Type cadeia
Values search
open_page
find

OpenAI.WebSearchPreviewTool

Observação: web_search ainda não está disponível via Azure OpenAI.

Name Tipo Description Required Default
search_context_size enumeração Diretrizes de alto nível para a quantidade de espaço de janela de contexto a ser usada para a pesquisa. Um de low, mediumou high. medium é o padrão.
Valores possíveis: low, , mediumhigh		 No
tipo enumeração O tipo da ferramenta de pesquisa na Web. Um de web_search_preview ou web_search_preview_2025_03_11.
Valores possíveis: web_search_preview		 Yes
user_location objeto No
└─ type OpenAI.LocationType No

OpenAI.WebSearchToolCallItemParam

Observação: web_search ainda não está disponível via Azure OpenAI.

Name Tipo Description Required Default
ação objeto Yes
└─ type OpenAI.WebSearchActionType No
tipo enumeração
Valores possíveis: web_search_call		 Yes

OpenAI.WebSearchToolCallItemResource

Observação: web_search ainda não está disponível via Azure OpenAI.

Name Tipo Description Required Default
ação objeto Yes
└─ type OpenAI.WebSearchActionType No
status enumeração O status da chamada da ferramenta de pesquisa na Web.
Valores possíveis: in_progress, , searching, completedfailed		 Yes
tipo enumeração
Valores possíveis: web_search_call		 Yes

PineconeChatDataSource

Name Tipo Description Required Default
parameters objeto As informações de parâmetro para controlar o uso da fonte de dados pinecone. Yes
└─ allow_partial_result boolean Se definido como true, o sistema permitirá que os resultados parciais da pesquisa sejam usados e a solicitação falhará se todas as consultas parciais falharem. Se não for especificada ou especificada como false, a solicitação falhará se qualquer consulta de pesquisa falhar. No False
└─ authentication objeto No
└─ key cadeia No
└─ type enumeração
Valores possíveis: api_key		 No
└─ embedding_dependency objeto Uma representação de uma fonte de vetorização de dados utilizável como um recurso de inserção com uma fonte de dados. No
└─ type AzureChatDataSourceVectorizationSourceType O identificador de diferenciação para a fonte de vetorização concreta. No
└─ environment cadeia O nome do ambiente a ser usado com Pinecone. No
└─ fields_mapping objeto Mapeamentos de campo a serem aplicados aos dados usados pela fonte de dados pinecone.
Observe que os mapeamentos de campo de conteúdo são necessários para Pinecone.		 No
└─ content_fields matriz No
└─ content_fields_separator cadeia No
└─ filepath_field cadeia No
└─ title_field cadeia No
└─ url_field cadeia No
└─ in_scope boolean Se as consultas devem ser restritas ao uso dos dados indexados. No
└─ include_contexts matriz As propriedades de contexto de saída a serem incluídas na resposta.
Por padrão, as citações e a intenção serão solicitadas.		 No ['citations', 'intent']
└─ index_name cadeia O nome do índice de banco de dados pinecone a ser usado. No
└─ max_search_queries inteiro O número máximo de consultas reescritas que devem ser enviadas ao provedor de pesquisa para uma única mensagem de usuário.
Por padrão, o sistema fará uma determinação automática.		 No
└─ strictness inteiro A rigidez configurada da filtragem de relevância da pesquisa.
A rigidez mais alta aumentará a precisão, mas diminuirá o recall da resposta.		 No
└─ top_n_documents inteiro O número configurado de documentos a serem apresentados na consulta. No
tipo enumeração O identificador de tipo discriminado, que é sempre "pinecone".
Valores possíveis: pinecone		 Yes

Quality

A qualidade do conteúdo do vídeo a ser recuperado. Isso especifica a qualidade do conteúdo do vídeo que deve ser retornado.

Property Value
Description A qualidade do conteúdo do vídeo a ser recuperado.
Isso especifica a qualidade do conteúdo do vídeo que deve ser retornado.
Type cadeia
Values high
low

ResponseFormatJSONSchemaRequest

Name Tipo Description Required Default
json_schema objeto Esquema JSON para o formato de resposta Yes
tipo enumeração Tipo de formato de resposta
Valores possíveis: json_schema		 Yes

ResponseModalities

Tipos de saída que você gostaria que o modelo gerasse. A maioria dos modelos é capaz de gerar texto, que é o padrão:

["text"]

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

["text", "audio"]

Matriz de: cadeia de caracteres

SpeechGenerationResponseFormat

Os formatos de saída de áudio com suporte para conversão de texto em fala.

Esse componente pode ser um dos seguintes:

VideoGeneration

Um resultado de geração de vídeo.

Name Tipo Description Required Default
created_at inteiro A hora em que a geração de vídeo foi criada. Yes
height inteiro A altura do vídeo. Yes
id cadeia A ID da geração de vídeo. Yes
job_id cadeia A ID do trabalho de geração de vídeo para este vídeo. Yes
n_seconds inteiro A duração da geração de vídeo. Yes
objeto enumeração
Valores possíveis: video.generation		 Yes
solicitação cadeia O prompt para essa geração de vídeo. Yes
width inteiro A largura do vídeo. Yes

VideoGenerationJob

Um trabalho de geração de vídeo.

Name Tipo Description Required Default
created_at inteiro A hora em que o trabalho foi criado. Yes
expires_at inteiro A hora em que o trabalho é excluído automaticamente do serviço. O conteúdo do vídeo e os metadados do trabalho devem ser armazenados antes dessa data para evitar a perda de dados. No
failure_reason cadeia de caracteres (veja os modelos válidos abaixo) No
finished_at inteiro A hora 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 determinado e do sucesso de criação das gerações. No
height inteiro A altura do vídeo. Yes
id cadeia A ID do trabalho. Yes
inpaint_items matriz Itens de insintação opcionais para este trabalho de geração de vídeo. No
modelo cadeia O nome da implantação a ser usada para este trabalho de geração de vídeo. Yes
n_seconds inteiro A duração do trabalho de geração de vídeo. Yes
n_variants inteiro O número de vídeos a serem criados como variantes para este trabalho de geração de vídeo. Yes
objeto enumeração
Valores possíveis: video.generation.job		 Yes
solicitação cadeia O prompt para este trabalho de geração de vídeo. Yes
status objeto O status de um trabalho de geração de vídeo. Yes
width inteiro A altura do vídeo. Yes

VideoGenerationJobList

Uma lista de trabalhos de geração de vídeo.

Name Tipo Description Required Default
dados matriz A lista de trabalhos de geração de vídeo. Yes
first_id cadeia A ID do primeiro trabalho na página atual, se disponível. No
has_more boolean Um sinalizador que indica se há mais trabalhos disponíveis após a lista. Yes
last_id cadeia A ID do último trabalho na página atual, se disponível. No
objeto enumeração
Valores possíveis: list		 Yes

Next steps

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

  • Last updated on