Azure OpenAI Chat

Versión de API: v1

Server:{endpoint}/openai/v1 — APIs de modelos Fundición de IA de Azure

Variables de servidor:

Variable Predeterminado Description
endpoint Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).

Autenticación

ApiKeyAuth (clave API)

Pasa tu clave API en la api-key cabecera.

ApiKeyAuth_ (clave API)

Pasa tu clave API en la authorization cabecera.

OAuth2Auth (OAuth 2.0)

Flow: implícito

Dirección URL de autorización:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos:

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

Requisitos de seguridad

Los endpoints aceptan cualquiera de los siguientes métodos de autenticación:

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

Creación de la finalización del chat

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

Crea una finalización de chat.

Parámetros de URI

Nombre In Obligatorio Tipo Description
endpoint server Sí string Un endpoint compatible con APIs de Fundición de IA de Azure Models, incluyendo protocolo y nombre de host.
Por ejemplo:
https://westus.api.cognitive.microsoft.com).
versión de la API query No string
Valores posibles: v1, preview		 La versión explícita de la API de modelos de Fundición de IA de Azure que se va a usar para esta solicitud.
v1 si no se especifica lo contrario.

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre Tipo Description Obligatorio Predeterminado
audio OpenAI.CreateChatCompletionRequestAudio o null Parámetros para la salida de audio. Obligatorio cuando se solicita la salida de audio con
modalities: ["audio"].		 No
penalización por frecuencia number o null Número entre -2.0 y 2.0. Los valores positivos penalizan nuevos tokens en función de
su frecuencia existente en el texto hasta ahora, lo que reduce el modelo.
probabilidad de repetir la misma línea textual.
Limitaciones: mínimo: -2, máximo: 2		 No
function_call cadena o OpenAI.ChatCompletionFunctionCallOption (obsoleto) En desuso en favor de tool_choice.
Controla la función (si existe) a la que llama el modelo.
none significa que el modelo no llamará a una función y, en su lugar, generará un
mensaje.
auto significa que el modelo puede elegir entre generar un mensaje o llamar a
function.
Especificar una función determinada a través de {"name": "my_function"} fuerzas
model para llamar a esa función.
none es el valor predeterminado cuando no hay funciones presentes. auto es el valor predeterminado.
si hay funciones presentes.		 No
functions array de OpenAI.ChatCompletionFunctions (obsoleto) En desuso en favor de tools.
Una lista de funciones para las que el modelo puede generar entradas JSON.
Restricciones: minObjetos: 1, máximoObjetos: 128		 No
logit_bias object o null Modifique la probabilidad de que aparezcan los tokens especificados en la finalización.
Acepta un objeto JSON que asigna tokens (especificados por su identificador de token en el
tokenizer) a un valor de sesgo asociado de -100 a 100. Matemáticamente
el sesgo se agrega a los logits generados por el modelo antes del muestreo.
El efecto exacto variará por modelo, pero los valores entre -1 y 1 deben
disminuir o aumentar la probabilidad de selección; valores como -100 o 100
debe dar lugar a una prohibición o selección exclusiva del token correspondiente.		 No
logprobs booleano o null Si se devuelven probabilidades de registro de los tokens de salida o no. Si es true,
devuelve las probabilidades de registro de cada token de salida devuelto en el
content de message.		 No
max_completion_tokens entero o null Límite superior para el número de tokens que se pueden generar para un
finalización, incluidos los tokens de salida visibles y los tokens de razonamiento.		 No
max_tokens entero o nulo (obsoleto) Número máximo de tokens que se pueden generar en la finalización del chat.
Este valor se puede usar para controlar los costos de texto generado a través de la API.

Este valor ahora está en desuso en favor de max_completion_tokensy es
no compatible con los modelos de la serie o1.		 No
messages matriz de OpenAI.ChatCompletionRequestMessage Una lista de mensajes que componen la conversación hasta ahora. Dependiendo de
modelo que se usa, se admiten diferentes tipos de mensajes (modalidades),
como texto, imágenes y audio.
Restricciones: minObjetos: 1		 Sí
metadatos OpenAI.Metadata o null No
modalidades OpenAI.ResponseModalities Tipos de salida que desea que genere el modelo.
La mayoría de los modelos son capaces de generar texto, que es el valor predeterminado:
["text"]
El gpt-4o-audio-preview modelo también se puede usar para
generar audio. Para solicitar que se genere este modelo
Tanto las respuestas de texto como las de audio puedes usar:
["text", "audio"]		 No
model string Id. de modelo usado para generar la respuesta, como gpt-4o o o3. OpenAI
ofrece una amplia gama de modelos con diferentes funcionalidades, rendimiento
características y puntos de precio. Consulte la guía del modelo.
para examinar y comparar los modelos disponibles.		 Sí
n entero o null Cuántas opciones de finalización de chat se van a generar para cada mensaje de entrada. Tenga en cuenta que se le cobrará en función del número de tokens generados en todas las opciones. Mantenga n el modo de 1 minimizar los costos.
Restricciones: mínimo: 1, máximo: 128		 No
parallel_tool_calls OpenAI.ParallelToolCalls Indica si se debe habilitar la llamada a funciones paralelas durante el uso de la herramienta. No
prediction OpenAI.PredictionContent Contenido de salida predicho estático, como el contenido de un archivo de texto que es
que se vuelve a generar.		 No
└─ Contenido cadena o matriz de OpenAI.ChatCompletionRequestMessageContentPartText El contenido que debe coincidir al generar una respuesta de modelo.
Si los tokens generados coinciden con este contenido, toda la respuesta del modelo
se puede devolver mucho más rápidamente.		 Sí
└─ Tipo enum Tipo del contenido previsto que desea proporcionar. Este tipo es
actualmente siempre content.
Valores posibles: content		 Sí
presence_penalty number o null Número entre -2.0 y 2.0. Los valores positivos penalizan nuevos tokens en función de
si aparecen en el texto hasta ahora, lo que aumenta la probabilidad del modelo
para hablar sobre nuevos temas.
Limitaciones: mínimo: -2, máximo: 2		 No
prompt_cache_key string Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares para optimizar las tasas de aciertos de caché. Reemplaza el user campo. Obtenga más información. No
prompt_cache_retention string o null No
esfuerzo de razonamiento OpenAI.ReasoningEffort Restringe el esfuerzo en el razonamiento de
modelos de razonamiento.
Actualmente, los valores admitidos son none, minimal, low, medium, highy xhigh. Reducir
el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados
sobre el razonamiento en una respuesta.
- gpt-5.1 el valor predeterminado es none, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son none, low, mediumy high. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1.
- Todos los modelos antes gpt-5.1 del esfuerzo de razonamiento predeterminado medium y no admiten none.
- El gpt-5-pro modelo tiene como valor predeterminado (y solo admite) high el esfuerzo de razonamiento.
- xhigh se admite para todos los modelos después gpt-5.1-codex-maxde .		 No
formato_de_respuesta OpenAI.CreateChatCompletionRequestResponseFormat Objeto que especifica el formato que debe generar el modelo.
Establecer en { "type": "json_schema", "json_schema": {...} } habilita
Salidas estructuradas que aseguran que el modelo coincidirá con el JSON que te proporcionó
esquema. Más información en Las salidas estructuradas
guía.
Al establecer en { "type": "json_object" } se habilita el modo JSON anterior, que
garantiza que el mensaje que genera el modelo es JSON válido. Usar json_schema
es preferible para los modelos que lo admiten.		 No
└─ Tipo OpenAI.CreateChatCompletionRequestResponseFormatType Sí
safety_identifier string Identificador estable que se usa para ayudar a detectar usuarios de la aplicación que pueden estar infringiendo las directivas de uso de OpenAI.
Los identificadores deben ser una cadena que identifique de forma única a cada usuario. Se recomienda aplicar un hash a su nombre de usuario o dirección de correo electrónico para evitar enviarnos información de identificación. Obtenga más información.		 No
inicialización entero o nulo (obsoleto) Esta característica está en beta.
Si se especifica, nuestro sistema hará un mejor esfuerzo para muestrear de forma determinista, de modo que las solicitudes repetidas con los mismos seed parámetros y deben devolver el mismo resultado.
El determinismo no está garantizado y debe hacer referencia al system_fingerprint parámetro de respuesta para supervisar los cambios en el back-end.		 No
stop OpenAI.StopConfiguration No se admite con los modelos más recientes de razonamiento o3 y o4-mini.
Hasta 4 secuencias en las que la API dejará de generar más tokens. El
el texto devuelto no contendrá la secuencia de detención.		 No
store booleano o null Indicar si se debe almacenar o no el resultado de esta solicitud de finalización de chat.
utilizar en los productos de destilación o devales del modelo.		 No
stream booleano o null Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente.
ya que se genera mediante eventos enviados por el servidor.		 No
stream_options OpenAI.ChatCompletionStreamOptions o null No
temperatura number o null No
tool_choice OpenAI.ChatCompletionToolChoiceOption Controla la herramienta a la que llama el modelo (si existe).
none significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje.
auto significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas.
required significa que el modelo debe llamar a una o varias herramientas.
Especificar una herramienta determinada a través de {"type": "function", "function": {"name": "my_function"}} fuerza al modelo a llamar a esa herramienta.
none es el valor predeterminado cuando no hay herramientas presentes. auto es el valor predeterminado si las herramientas están presentes.		 No
tools matriz de OpenAI.ChatCompletionTool o OpenAI.CustomToolChatCompletions Una lista de herramientas a las que puede llamar el modelo. Puede proporcionar cualquiera de los dos
herramientas personalizadas o
herramientas de funciones.		 No
top_logprobs entero o null No
top_p number o null No
user string (en desuso) Identificador único que representa al usuario final, que puede ayudar a
supervisar y detectar abusos.		 No
user_security_context AzureUserSecurityContext El contexto de seguridad del usuario contiene varios parámetros que describen la propia aplicación y el usuario final que interactúa con la aplicación. Estos campos ayudan a los equipos de operaciones de seguridad a investigar y mitigar los incidentes de seguridad al proporcionar un enfoque integral para proteger las aplicaciones de inteligencia artificial. Learn más sobre la protección de aplicaciones de inteligencia artificial mediante Microsoft Defender para la nube. No
detalle OpenAI.Verbosity Restringe el nivel de detalle de la respuesta del modelo. Los valores inferiores darán como resultado
respuestas más concisas, mientras que los valores más altos darán lugar a respuestas más detalladas.
Actualmente, los valores admitidos son low, mediumy high.		 No

Responses

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido Type Descripción
application/json objeto o objeto

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido Type Descripción
application/json object
Nombre Tipo Description Obligatorio Predeterminado
código string o null Sí
inner_error No
message string Sí
param string o null Sí
type string Sí

Encabezados de respuesta:

Encabezado Tipo Description
apim-request-id string Identificador de solicitud que se usa para solucionar problemas.

Examples

Example

Crea una finalización para el símbolo del sistema, los parámetros y el modelo elegido proporcionados.

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

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

Respuestas:

Código de estado: 200

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

Components

AzureAIFoundryModelsApiVersion

Propiedad Value
Type string
Valores v1
preview

AzureContentFilterBlocklistResult

Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas.

Nombre Tipo Description Obligatorio Predeterminado
details matriz de objeto Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado. No
filtered boolean Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado. Sí

AzureContentFilterCompletionTextSpan

Representación de un fragmento de texto de finalización tal como lo usan los resultados del filtro de contenido de Azure OpenAI.

Nombre Tipo Description Obligatorio Predeterminado
completion_end_offset entero (int32) Desplazamiento del primer punto de código UTF32 que se excluye del intervalo. Este campo siempre es igual a completion_start_offset para intervalos vacíos. Este campo siempre es mayor que completion_start_offset para intervalos no vacíos. Sí
completion_start_offset entero (int32) Desplazamiento del punto de código UTF32 que comienza el intervalo. Sí

AzureContentFilterCompletionTextSpanDetectionResult

Nombre Tipo Description Obligatorio Predeterminado
details matriz de AzureContentFilterCompletionTextSpan Información detallada sobre los intervalos de texto de finalización detectados. Sí
detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
filtered boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí

AzureContentFilterCustomTopicResult

Colección de resultados de filtrado true/false para temas personalizados configurados.

Nombre Tipo Description Obligatorio Predeterminado
details matriz de objeto Pares de identificadores de tema individuales y si se detectan. No
filtered boolean Valor que indica si alguno de los temas detallados produjo una acción de filtrado. Sí

AzureContentFilterDetectionResult

Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.

Nombre Tipo Description Obligatorio Predeterminado
detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
filtered boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí

AzureContentFilterPersonallyIdentifiableInformationResult

Resultado de la detección de filtros de contenido para información de identificación personal que incluye extensiones perjudiciales.

Nombre Tipo Description Obligatorio Predeterminado
detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
filtered boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
redacted_text string Texto censurado con información de PII quitada o enmascarada. No
sub_categories matriz de AzurePiiSubCategoryResult Resultados detallados de PIIHarmSubCategory(s) individuales. No

AzureContentFilterResultForChoice

Resultado del filtro de contenido para un único elemento de respuesta generado por un sistema de IA generativo.

Nombre Tipo Description Obligatorio Predeterminado
custom_blocklists AzureContentFilterBlocklistResult Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas. No
└─ detalles matriz de objeto Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado. No
└* filtrado boolean Valor que indica si la lista de bloqueados generó una acción de filtrado. Sí
└─ id. string Identificador de la lista de bloques personalizada evaluada. Sí
└* filtrado boolean Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado. Sí
custom_topics AzureContentFilterCustomTopicResult Colección de resultados de filtrado true/false para temas personalizados configurados. No
└─ detalles matriz de objeto Pares de identificadores de tema individuales y si se detectan. No
└─ detectado boolean Valor que indica si se detecta el tema. Sí
└─ id. string Identificador del tema personalizado evaluado. Sí
└* filtrado boolean Valor que indica si alguno de los temas detallados produjo una acción de filtrado. Sí
error object Si está presente, detalles sobre un error que impidió que se completara la evaluación del filtrado de contenido. No
└─ código entero (int32) Un código distinto legible por la máquina asociado al error. Sí
└─ Mensaje string Mensaje legible asociado al error. Sí
odio AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
personally_identifiable_information AzureContentFilterPersonallyIdentifiableInformationResult Resultado de la detección de filtros de contenido para información de identificación personal que incluye extensiones perjudiciales. No
└" redacted_text string Texto censurado con información de PII quitada o enmascarada. No
└─ sub_categorías matriz de AzurePiiSubCategoryResult Resultados detallados de PIIHarmSubCategory(s) individuales. No
soece AzureContentFilterDetectionResult Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era
filtrada.		 No
└─ detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
└* filtrado boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
protected_material_code object Resultado de detección que describe una coincidencia con el código con licencia u otro material de origen protegido. No
└─ cita object Si está disponible, los detalles de la cita que describen la licencia asociada y su ubicación. No
└─ URL string (URI) Dirección URL asociada a la licencia. No
└─ Licencia string Nombre o identificador de la licencia asociada a la detección. No
└─ detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
└* filtrado boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
protected_material_text AzureContentFilterDetectionResult Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era
filtrada.		 No
└─ detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
└* filtrado boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
self_harm AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
sexual AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult No
violencia AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí

AzureContentFilterResultForPrompt

Resultado del filtro de contenido asociado a un único elemento de solicitud de entrada en un sistema de IA generativo.

Nombre Tipo Description Obligatorio Predeterminado
content_filter_results object Detalles de la categoría del filtro de contenido para el resultado. No
└─ listas_de_bloqueo_personalizadas AzureContentFilterBlocklistResult Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas. No
└─ detalles matriz de objeto Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado. No
└* filtrado boolean Valor que indica si la lista de bloqueados generó una acción de filtrado. Sí
└─ id. string Identificador de la lista de bloques personalizada evaluada. Sí
└* filtrado boolean Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado. Sí
└─ temas_personalizados AzureContentFilterCustomTopicResult Colección de resultados de filtrado true/false para temas personalizados configurados. No
└─ detalles matriz de objeto Pares de identificadores de tema individuales y si se detectan. No
└─ detectado boolean Valor que indica si se detecta el tema. Sí
└─ id. string Identificador del tema personalizado evaluado. Sí
└* filtrado boolean Valor que indica si alguno de los temas detallados produjo una acción de filtrado. Sí
└─ Error object Si está presente, detalles sobre un error que impidió que se completara la evaluación del filtrado de contenido. No
└─ código entero (int32) Un código distinto legible por la máquina asociado al error. Sí
└─ Mensaje string Mensaje legible asociado al error. Sí
└─ odio AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
└─ ataque_indirecto AzureContentFilterDetectionResult Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era
filtrada.		 Sí
└─ detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
└* filtrado boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
└─ liberar AzureContentFilterDetectionResult Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era
filtrada.		 Sí
└─ detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
└* filtrado boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
└─ blasfemia AzureContentFilterDetectionResult Elemento de resultado del filtro de contenido etiquetado que indica si se detectó el contenido y si el contenido era
filtrada.		 No
└─ detectado boolean Indica si se detectó la categoría de contenido con etiqueta en el contenido. Sí
└* filtrado boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido. Sí
└─ autolesión AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
└— sexual AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
└─ violencia AzureContentFilterSeverityResult Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se ha filtrado y cuál es la calidad
el nivel de gravedad del contenido se ha evaluado con respecto a la configuración del filtro de contenido de la categoría.		 No
└* filtrado boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
└─ gravedad enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí
prompt_index entero (int32) Índice del indicador de entrada asociado a las categorías de resultados del filtro de contenido acompañante. No

AzureContentFilterSeverityResult

Elemento de resultado de filtro de contenido etiquetado que indica si se filtró el contenido y cuál era el nivel de gravedad cualitativo del contenido, según se evaluó en relación con el filtro de contenido configurado para la categoría.

Nombre Tipo Description Obligatorio Predeterminado
filtered boolean Si la gravedad del contenido dio lugar a una acción de filtrado de contenido. Sí
severity enum La gravedad etiquetada del contenido.
Valores posibles: safe, low, medium, high		 Sí

AzurePiiSubCategoryResult

Detalles del resultado de PIIHarmSubCategory(s) individuales.

Nombre Tipo Description Obligatorio Predeterminado
detectado boolean Indica si se detectó la subcategoría de contenido con etiqueta en el contenido. Sí
filtered boolean Si la detección de contenido dio lugar a una acción de filtrado de contenido para esta subcategoría. Sí
redactada boolean Si el contenido se redactó para esta subcategoría. Sí
sub_category string PiIHarmSubCategory que se evaluó. Sí

AzureUserSecurityContext

El contexto de seguridad del usuario contiene varios parámetros que describen la propia aplicación y el usuario final que interactúa con la aplicación. Estos campos ayudan a los equipos de operaciones de seguridad a investigar y mitigar los incidentes de seguridad al proporcionar un enfoque integral para proteger las aplicaciones de inteligencia artificial. Learn más sobre la protección de aplicaciones de inteligencia artificial mediante Microsoft Defender para la nube.

Nombre Tipo Description Obligatorio Predeterminado
application_name string Nombre de la aplicación. La información personal confidencial no debe incluirse en este campo. No
end_user_id string Este identificador es el identificador de objeto de usuario de Microsoft Entra ID (anteriormente Azure Active Directory) que se usa para autenticar a los usuarios finales dentro de la aplicación de IA generativa. La información personal confidencial no debe incluirse en este campo. No
end_user_tenant_id string El ID de arrendatario de Microsoft 365 al que pertenece el usuario final. Es necesario cuando la aplicación de IA generativa tiene una arquitectura multitenencia. No
source_ip string Captura la dirección IP del cliente original. No

OpenAI.ChatCompletionAllowedTools

Herramientas permitidas

Restringe las herramientas disponibles para el modelo a un conjunto predefinido.

Nombre Tipo Description Obligatorio Predeterminado
mode enum Restringe las herramientas disponibles para el modelo a un conjunto predefinido.
auto permite que el modelo elija entre las herramientas permitidas y genere un
mensaje.
required requiere que el modelo llame a una o varias de las herramientas permitidas.
Valores posibles: auto, required		 Sí
tools matriz de objeto Lista de definiciones de herramientas a las que se debe permitir que el modelo llame.
En el caso de la API De finalizaciones de chat, la lista de definiciones de herramientas podría ser similar a la siguiente:
json<br> [<br> { "type": "function", "function": { "name": "get_weather" } },<br> { "type": "function", "function": { "name": "get_time" } }<br> ]<br> 		Sí

OpenAI.ChatCompletionAllowedToolsChoice

Herramientas permitidas

Restringe las herramientas disponibles para el modelo a un conjunto predefinido.

Nombre Tipo Description Obligatorio Predeterminado
herramientas_permitidas OpenAI.ChatCompletionAllowedTools Restringe las herramientas disponibles para el modelo a un conjunto predefinido. Sí
type enum Tipo de configuración de herramienta permitido. Siempre allowed_tools.
Valores posibles: allowed_tools		 Sí

OpenAI.ChatCompletionFunctionCallOption

Especificar una función determinada a través de {"name": "my_function"} obliga al modelo a llamar a esa función.

Nombre Tipo Description Obligatorio Predeterminado
nombre string El nombre de la función para llamar. Sí

OpenAI.ChatCompletionFunctions

Nombre Tipo Description Obligatorio Predeterminado
description string Descripción de lo que hace la función, que usa el modelo para elegir cuándo y cómo llamar a la función. No
nombre string El nombre de la función que se llamará. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64. Sí
parameters OpenAI.FunctionParameters Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulta la guía para ejemplos y la referencia del esquema JSON para documentación sobre el formato.
La omisión parameters define una función con una lista de parámetros vacía.		 No

OpenAI.ChatCompletionMessageCustomToolCall

Llamada a herramienta personalizada

Una llamada a una herramienta personalizada creada por el modelo.

Nombre Tipo Description Obligatorio Predeterminado
custom OpenAI.ChatCompletionMessageCustomToolCallCustom Sí
└─ Entrada string Sí
└─ Nombre string Sí
id string Identificador de la llamada a la herramienta. Sí
type enum Tipo de la herramienta. Siempre custom.
Valores posibles: custom		 Sí

OpenAI.ChatCompletionMessageCustomToolCallCustom

Nombre Tipo Description Obligatorio Predeterminado
input string Sí
nombre string Sí

OpenAI.ChatCompletionMessageToolCall

Llamada a la herramienta de función

Una llamada a una herramienta de función creada por el modelo.

Nombre Tipo Description Obligatorio Predeterminado
function OpenAI.ChatCompletionMessageToolCallFunction Sí
└ Argumentos string Sí
└─ Nombre string Sí
id string Identificador de la llamada a la herramienta. Sí
type enum Tipo de la herramienta. Actualmente, solo se admite function.
Valores posibles: function		 Sí

OpenAI.ChatCompletionMessageToolCallChunk

Nombre Tipo Description Obligatorio Predeterminado
function OpenAI.ChatCompletionMessageToolCallChunkFunction No
id string Identificador de la llamada a la herramienta. No
index integer Sí
type enum Tipo de la herramienta. Actualmente, solo se admite function.
Valores posibles: function		 No

OpenAI.ChatCompletionMessageToolCallChunkFunction

Nombre Tipo Description Obligatorio Predeterminado
argumentos string No
nombre string No

OpenAI.ChatCompletionMessageToolCallFunction

Nombre Tipo Description Obligatorio Predeterminado
argumentos string Sí
nombre string Sí

OpenAI.ChatCompletionMessageToolCalls

La herramienta llama a las llamadas generadas por el modelo, como las llamadas de función.

OpenAI.ChatCompletionMessageToolCallsItem

La herramienta llama a las llamadas generadas por el modelo, como las llamadas de función.

OpenAI.ChatCompletionNamedToolChoice

Elección de la herramienta funcional

Especifica una herramienta que debe usar el modelo. Use para forzar que el modelo llame a una función específica.

Nombre Tipo Description Obligatorio Predeterminado
function OpenAI.ChatCompletionNamedToolChoiceFunction Sí
type enum En el caso de las llamadas a funciones, el tipo siempre es function.
Valores posibles: function		 Sí

OpenAI.ChatCompletionNamedToolChoiceCustom

Elección de herramienta personalizada

Especifica una herramienta que debe usar el modelo. Use para forzar al modelo a llamar a una herramienta personalizada específica.

Nombre Tipo Description Obligatorio Predeterminado
custom OpenAI.ChatCompletionNamedToolChoiceCustomCustom Sí
type enum En el caso de las llamadas a herramientas personalizadas, el tipo siempre customes .
Valores posibles: custom		 Sí

OpenAI.ChatCompletionNamedToolChoiceCustomCustom

Nombre Tipo Description Obligatorio Predeterminado
nombre string Sí

OpenAI.ChatCompletionNamedToolChoiceFunction

Nombre Tipo Description Obligatorio Predeterminado
nombre string Sí

OpenAI.ChatCompletionRequestAssistantMessage

Mensaje del asistente

Mensajes enviados por el modelo en respuesta a los mensajes del usuario.

Nombre Tipo Description Obligatorio Predeterminado
audio OpenAI.ChatCompletionRequestAssistantMessageAudio o null Datos sobre una respuesta de audio anterior del modelo. No
contenido cadena o matriz de OpenAI.ChatCompletionRequestAssistantMessageContentPart o null No
function_call OpenAI.ChatCompletionRequestAssistantMessageFunctionCall o null No
nombre string Un nombre opcional para el participante. Proporciona la información del modelo para diferenciar entre los participantes del mismo rol. No
refusal string o null No
role enum Rol del autor de mensajes, en este caso assistant.
Valores posibles: assistant		 Sí
tool_calls OpenAI.ChatCompletionMessageToolCalls La herramienta llama a las llamadas generadas por el modelo, como las llamadas de función. No

OpenAI.ChatCompletionRequestAssistantMessageAudio

Nombre Tipo Description Obligatorio Predeterminado
id string Sí

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestAssistantMessageContentPart

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor Schema
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
text OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText
Nombre Tipo Description Obligatorio Predeterminado
type OpenAI.ChatCompletionRequestAssistantMessageContentPartType Sí

OpenAI.ChatCompletionRequestAssistantMessageContentPartChatCompletionRequestMessageContentPartText

Parte del contenido de texto

Obtenga información sobre las entradas de texto.

Nombre Tipo Description Obligatorio Predeterminado
text string Contenido de texto. Sí
type enum Tipo del elemento de contenido.
Valores posibles: text		 Sí

OpenAI.ChatCompletionRequestAssistantMessageContentPartType

Propiedad Value
Type string
Valores text
refusal

OpenAI.ChatCompletionRequestAssistantMessageFunctionCall

Nombre Tipo Description Obligatorio Predeterminado
argumentos string Sí
nombre string Sí

OpenAI.ChatCompletionRequestDeveloperMessage

Mensaje del desarrollador

Instrucciones proporcionadas por el desarrollador que el modelo debe seguir, independientemente de los mensajes enviados por el usuario. Con los modelos o1 y versiones más recientes, developer los mensajes reemplazan los mensajes anteriores system .

Nombre Tipo Description Obligatorio Predeterminado
contenido cadena o matriz de OpenAI.ChatCompletionRequestMessageContentPartText Contenido del mensaje del desarrollador. Sí
nombre string Un nombre opcional para el participante. Proporciona la información del modelo para diferenciar entre los participantes del mismo rol. No
role enum Rol del autor de mensajes, en este caso developer.
Valores posibles: developer		 Sí

OpenAI.ChatCompletionRequestFunctionMessage

Mensaje de función

Nombre Tipo Description Obligatorio Predeterminado
contenido string o null Sí
nombre string El nombre de la función para llamar. Sí
role enum Rol del autor de mensajes, en este caso function.
Valores posibles: function		 Sí

OpenAI.ChatCompletionRequestMessage

Discriminador para OpenAI.ChatCompletionRequestMessage

Este componente usa la propiedad role para discriminar entre diferentes tipos:

Tipo de valor Schema
assistant OpenAI.ChatCompletionRequestAssistantMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
function OpenAI.ChatCompletionRequestFunctionMessage
system OpenAI.ChatCompletionRequestSystemMessage
user OpenAI.ChatCompletionRequestUserMessage
tool OpenAI.ChatCompletionRequestToolMessage
Nombre Tipo Description Obligatorio Predeterminado
role OpenAI.ChatCompletionRequestMessageType Sí

OpenAI.ChatCompletionRequestMessageContentPartAudio

Parte de contenido de audio

Nombre Tipo Description Obligatorio Predeterminado
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio Sí
type enum Tipo del elemento de contenido. Siempre input_audio.
Valores posibles: input_audio		 Sí

OpenAI.ChatCompletionRequestMessageContentPartAudioInputAudio

Nombre Tipo Description Obligatorio Predeterminado
data string Sí
format enum
Valores posibles: wav, mp3		 Sí

OpenAI.ChatCompletionRequestMessageContentPartFile

Parte de contenido del archivo

Obtenga información sobre las entradas de archivo para la generación de texto.

Nombre Tipo Description Obligatorio Predeterminado
file OpenAI.ChatCompletionRequestMessageContentPartFileFile Sí
└─ file_data string No
└─ file_id string No
└─ nombre de archivo string No
type enum Tipo del elemento de contenido. Siempre file.
Valores posibles: file		 Sí

OpenAI.ChatCompletionRequestMessageContentPartFileFile

Nombre Tipo Description Obligatorio Predeterminado
file_data string No
ID del archivo string No
filename string No

OpenAI.ChatCompletionRequestMessageContentPartImage

Parte de contenido de la imagen

Nombre Tipo Description Obligatorio Predeterminado
image_url OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl Sí
type enum Tipo del elemento de contenido.
Valores posibles: image_url		 Sí

OpenAI.ChatCompletionRequestMessageContentPartImageImageUrl

Nombre Tipo Description Obligatorio Predeterminado
detail enum
Valores posibles: auto, low, high		 No auto
url string (URI) Sí

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Parte de contenido de rechazo

Nombre Tipo Description Obligatorio Predeterminado
refusal string Mensaje de denegación generado por el modelo. Sí
type enum Tipo del elemento de contenido.
Valores posibles: refusal		 Sí

OpenAI.ChatCompletionRequestMessageContentPartText

Parte del contenido de texto

Nombre Tipo Description Obligatorio Predeterminado
text string Contenido de texto. Sí
type enum Tipo del elemento de contenido.
Valores posibles: text		 Sí

OpenAI.ChatCompletionRequestMessageType

Propiedad Value
Type string
Valores developer
system
user
assistant
tool
function

OpenAI.ChatCompletionRequestSystemMessage

Mensaje del sistema

Instrucciones proporcionadas por el desarrollador que el modelo debe seguir, independientemente de los mensajes enviados por el usuario. Con los modelos o1 y versiones más recientes, use en su lugar los mensajes developer para este propósito.

Nombre Tipo Description Obligatorio Predeterminado
contenido cadena o matriz de OpenAI.ChatCompletionRequestSystemMessageContentPart Contenido del mensaje del sistema. Sí
nombre string Un nombre opcional para el participante. Proporciona la información del modelo para diferenciar entre los participantes del mismo rol. No
role enum Rol del autor de mensajes, en este caso system.
Valores posibles: system		 Sí

OpenAI.ChatCompletionRequestSystemMessageContentPart

Referencias: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

Mensaje de la herramienta

Nombre Tipo Description Obligatorio Predeterminado
contenido cadena o matriz de OpenAI.ChatCompletionRequestToolMessageContentPart Contenido del mensaje de la herramienta. Sí
role enum Rol del autor de mensajes, en este caso tool.
Valores posibles: tool		 Sí
tool_call_id string Llamada a la herramienta a la que responde este mensaje. Sí

OpenAI.ChatCompletionRequestToolMessageContentPart

Referencias: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

Mensaje de usuario

Mensajes enviados por un usuario final, que contienen mensajes o información de contexto adicional.

Nombre Tipo Description Obligatorio Predeterminado
contenido cadena o matriz de OpenAI.ChatCompletionRequestUserMessageContentPart Contenido del mensaje de usuario. Sí
nombre string Un nombre opcional para el participante. Proporciona la información del modelo para diferenciar entre los participantes del mismo rol. No
role enum Rol del autor de mensajes, en este caso user.
Valores posibles: user		 Sí

OpenAI.ChatCompletionRequestUserMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestUserMessageContentPart

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor Schema
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
file OpenAI.ChatCompletionRequestMessageContentPartFile
text OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText
Nombre Tipo Description Obligatorio Predeterminado
type OpenAI.ChatCompletionRequestUserMessageContentPartType Sí

OpenAI.ChatCompletionRequestUserMessageContentPartChatCompletionRequestMessageContentPartText

Parte del contenido de texto

Obtenga información sobre las entradas de texto.

Nombre Tipo Description Obligatorio Predeterminado
text string Contenido de texto. Sí
type enum Tipo del elemento de contenido.
Valores posibles: text		 Sí

OpenAI.ChatCompletionRequestUserMessageContentPartType

Propiedad Value
Type string
Valores text
image_url
input_audio
file

OpenAI.ChatCompletionResponseMessage

Si se solicita la modalidad de salida de audio, este objeto contiene datos sobre la respuesta de audio del modelo.

Nombre Tipo Description Obligatorio Predeterminado
annotations matriz de OpenAI.ChatCompletionResponseMessageAnnotations Anotaciones para el mensaje, cuando corresponda, como cuando se usa
herramienta de búsqueda web.		 No
audio OpenAI.ChatCompletionResponseMessageAudio o null No
contenido string o null Sí
function_call OpenAI.ChatCompletionResponseMessageFunctionCall (obsoleto) No
└ Argumentos string Sí
└─ Nombre string Sí
reasoning_content string Propiedad de extensión específica de Azure que contiene contenido de razonamiento generado a partir de modelos admitidos. No
refusal string o null Sí
role enum Rol del autor de este mensaje.
Valores posibles: assistant		 Sí
tool_calls OpenAI.ChatCompletionMessageToolCallsItem La herramienta llama a las llamadas generadas por el modelo, como las llamadas de función. No

OpenAI.ChatCompletionResponseMessageAnnotations

Nombre Tipo Description Obligatorio Predeterminado
type enum
Valores posibles: url_citation		 Sí
url_citation OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation Sí

OpenAI.ChatCompletionResponseMessageAnnotationsUrlCitation

Nombre Tipo Description Obligatorio Predeterminado
end_index integer Sí
start_index integer Sí
title string Sí
url string Sí

OpenAI.ChatCompletionResponseMessageAudio

Nombre Tipo Description Obligatorio Predeterminado
data string Sí
expires_at entero (unixtime) Sí
id string Sí
transcript string Sí

OpenAI.ChatCompletionResponseMessageFunctionCall

Nombre Tipo Description Obligatorio Predeterminado
argumentos string Sí
nombre string Sí

OpenAI.ChatCompletionStreamOptions

Opciones para la respuesta de streaming. Establézcalo solo cuando establezca stream: true.

Nombre Tipo Description Obligatorio Predeterminado
include_obfuscation boolean Cuando sea true, se habilitará la ofuscación de la secuencia. Agrega ofuscación de secuencias
caracteres aleatorios a un obfuscation campo en el streaming de eventos delta a
normalice los tamaños de carga como una mitigación de determinados ataques de canal lateral.
Estos campos de ofuscación se incluyen de forma predeterminada, pero agregan una pequeña cantidad.
de sobrecarga en el flujo de datos. Puede establecer en include_obfuscation .
false para optimizar el ancho de banda si confía en los vínculos de red entre
la aplicación y la API de OpenAI.		 No
include_usage boolean Si se establece, se transmitirá un fragmento adicional antes del data: [DONE]
mensaje. El usage campo de este fragmento muestra las estadísticas de uso de tokens.
para toda la solicitud y el choices campo siempre será un vacío.
matriz
Todos los demás fragmentos también incluirán un usage campo, pero con un valor NULL
value. NOTA: Si se interrumpe la transmisión, es posible que no reciba el
fragmento de uso final que contiene el uso total del token para la solicitud.		 No

OpenAI.ChatCompletionStreamResponseDelta

Una diferencia de finalización del chat generada por respuestas del modelo transmitido.

Nombre Tipo Description Obligatorio Predeterminado
contenido string o null No
function_call OpenAI.ChatCompletionStreamResponseDeltaFunctionCall (obsoleto) No
└ Argumentos string No
└─ Nombre string No
reasoning_content string Propiedad de extensión específica de Azure que contiene contenido de razonamiento generado a partir de modelos admitidos. No
refusal string o null No
role enum Rol del autor de este mensaje.
Valores posibles: developer, system, user, , assistant, tool		 No
tool_calls matriz de OpenAI.ChatCompletionMessageToolCallChunk No

OpenAI.ChatCompletionStreamResponseDeltaFunctionCall

Nombre Tipo Description Obligatorio Predeterminado
argumentos string No
nombre string No

OpenAI.ChatCompletionTokenLogprob

Nombre Tipo Description Obligatorio Predeterminado
bytes matriz de enteros o null Sí
logprob número Probabilidad de registro de este token, si está dentro de los 20 tokens más probables. De lo contrario, el valor -9999.0 se usa para indicar que el token es muy poco probable. Sí
token string Token. Sí
top_logprobs matriz de OpenAI.ChatCompletionTokenLogprobTopLogprobs Lista de los tokens más probables y su probabilidad de registro, en esta posición del token. En raras ocasiones, puede haber menos del número de devueltos solicitados top_logprobs . Sí

OpenAI.ChatCompletionTokenLogprobTopLogprobs

Nombre Tipo Description Obligatorio Predeterminado
bytes matriz de enteros o null Sí
logprob número Sí
token string Sí

OpenAI.ChatCompletionTool

Herramienta de función

Herramienta de función que se puede usar para generar una respuesta.

Nombre Tipo Description Obligatorio Predeterminado
function OpenAI.FunctionObject Sí
type enum Tipo de la herramienta. Actualmente, solo se admite function.
Valores posibles: function		 Sí

OpenAI.ChatCompletionToolChoiceOption

Controla la herramienta a la que llama el modelo (si existe). none significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. auto significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. required significa que el modelo debe llamar a una o varias herramientas. Especificar una herramienta determinada a través de {"type": "function", "function": {"name": "my_function"}} fuerza al modelo a llamar a esa herramienta. none es el valor predeterminado cuando no hay herramientas presentes. auto es el valor predeterminado si las herramientas están presentes.

Tipo: string o OpenAI.ChatCompletionAllowedToolsChoice o OpenAI.ChatCompletionNamedToolChoice o OpenAI.ChatCompletionNamedToolChoiceCustom

Controla la herramienta a la que llama el modelo (si existe). none significa que el modelo no llamará a ninguna herramienta y, en su lugar, generará un mensaje. auto significa que el modelo puede elegir entre generar un mensaje o llamar a una o varias herramientas. required significa que el modelo debe llamar a una o varias herramientas. Especificar una herramienta determinada a través de {"type": "function", "function": {"name": "my_function"}} fuerza al modelo a llamar a esa herramienta. none es el valor predeterminado cuando no hay herramientas presentes. auto es el valor predeterminado si las herramientas están presentes.

OpenAI.CompletionUsage

Estadísticas de uso de la solicitud de finalización.

Nombre Tipo Description Obligatorio Predeterminado
completion_tokens integer Número de tokens en la finalización generada. Sí
completion_tokens_details OpenAI.CompletionUsageCompletionTokensDetails No
└─ tokens_de_prediccion_aceptados integer No
└─ audio_tokens integer No
─ reasoning_tokens integer No
└─ tokens_de_prediccion_rechazados integer No
prompt_tokens integer Número de tokens en el símbolo del sistema. Sí
prompt_tokens_details OpenAI.CompletionUsagePromptTokensDetails No
└─ audio_tokens integer No
└─ tokens en caché integer No
total_tokens integer Número total de tokens usados en la solicitud (solicitud + finalización). Sí

OpenAI.CompletionUsageCompletionTokensDetails

Nombre Tipo Description Obligatorio Predeterminado
accepted_prediction_tokens integer No
audio_tokens integer No
reasoning_tokens integer No
rejected_prediction_tokens integer No

OpenAI.CompletionUsagePromptTokensDetails

Nombre Tipo Description Obligatorio Predeterminado
audio_tokens integer No
cached_tokens integer No

OpenAI.CreateChatCompletionRequestAudio

Nombre Tipo Description Obligatorio Predeterminado
format enum
Valores posibles: wav, aac, mp3, flac, , opus, pcm16		 Sí
voz OpenAI.VoiceIdsShared Sí

OpenAI.CreateChatCompletionRequestResponseFormat

Objeto que especifica el formato que debe generar el modelo. Establecer en { "type": "json_schema", "json_schema": {...} } habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. Aprende más en la guía de Structured Outputs. Establecer en { "type": "json_object" } habilita el modo JSON anterior, lo que garantiza que el mensaje que genera el modelo sea JSON válido. Se prefiere usar json_schema para los modelos que lo admiten.

Discriminador para OpenAI.CreateChatCompletionRequestResponseFormat

Este componente usa la propiedad type para discriminar entre diferentes tipos:

Tipo de valor Schema
json_schema OpenAI.ResponseFormatJsonSchema
text OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject
Nombre Tipo Description Obligatorio Predeterminado
type OpenAI.CreateChatCompletionRequestResponseFormatType Sí

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Objeto JSON

Formato de respuesta de objeto JSON. Un método anterior para generar respuestas JSON. Se recomienda usar json_schema para los modelos que lo admiten. Tenga en cuenta que el modelo no generará JSON sin un mensaje del usuario o del sistema que lo indique.

Nombre Tipo Description Obligatorio Predeterminado
type enum Tipo de formato de respuesta que se va a definir. Siempre json_object.
Valores posibles: json_object		 Sí

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Text

Formato de respuesta predeterminado. Se usa para generar respuestas de texto.

Nombre Tipo Description Obligatorio Predeterminado
type enum Tipo de formato de respuesta que se va a definir. Siempre text.
Valores posibles: text		 Sí

OpenAI.CreateChatCompletionRequestResponseFormatType

Propiedad Value
Type string
Valores text
json_schema
json_object

OpenAI.CreateChatCompletionResponseChoices

Nombre Tipo Description Obligatorio Predeterminado
content_filter_results AzureContentFilterResultForChoice Resultado del filtro de contenido para un único elemento de respuesta generado por un sistema de IA generativo. No
razón de finalización enum
Valores posibles: stop, length, tool_calls, , content_filter, function_call		 Sí
index integer Sí
logprobs OpenAI.CreateChatCompletionResponseChoicesLogprobs o null Sí
message OpenAI.ChatCompletionResponseMessage Si se solicita la modalidad de salida de audio, este objeto contiene datos.
acerca de la respuesta de audio del modelo.		 Sí

OpenAI.CreateChatCompletionResponseChoicesLogprobs

Nombre Tipo Description Obligatorio Predeterminado
contenido matriz de OpenAI.ChatCompletionTokenLogprob o null Sí
refusal matriz de OpenAI.ChatCompletionTokenLogprob o null Sí

OpenAI.CreateChatCompletionStreamResponseChoices

Nombre Tipo Description Obligatorio Predeterminado
delta OpenAI.ChatCompletionStreamResponseDelta Una diferencia de finalización del chat generada por respuestas del modelo transmitido. Sí
razón de finalización string o null Sí
index integer Sí
logprobs OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs o null No

OpenAI.CreateChatCompletionStreamResponseChoicesLogprobs

Nombre Tipo Description Obligatorio Predeterminado
contenido matriz de OpenAI.ChatCompletionTokenLogprob o null Sí
refusal matriz de OpenAI.ChatCompletionTokenLogprob o null Sí

OpenAI.CustomToolChatCompletions

Herramienta personalizada

Una herramienta personalizada que procesa la entrada mediante un formato especificado.

Nombre Tipo Description Obligatorio Predeterminado
custom OpenAI.CustomToolChatCompletionsCustom Sí
└─ Descripción string No
└─ Formato OpenAI.CustomToolChatCompletionsCustomFormatText o OpenAI.CustomToolChatCompletionsCustomFormatGrammar No
└─ Nombre string Sí
type enum Tipo de la herramienta personalizada. Siempre custom.
Valores posibles: custom		 Sí

OpenAI.CustomToolChatCompletionsCustom

Nombre Tipo Description Obligatorio Predeterminado
description string No
format OpenAI.CustomToolChatCompletionsCustomFormatText o OpenAI.CustomToolChatCompletionsCustomFormatGrammar No
nombre string Sí

OpenAI.CustomToolChatCompletionsCustomFormatGrammar

Nombre Tipo Description Obligatorio Predeterminado
gramática OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar Sí
Definición └ string Sí
Sintaxis └ enum
Valores posibles: lark, regex		 Sí
type enum
Valores posibles: grammar		 Sí

OpenAI.CustomToolChatCompletionsCustomFormatGrammarGrammar

Nombre Tipo Description Obligatorio Predeterminado
definición string Sí
sintaxis enum
Valores posibles: lark, regex		 Sí

OpenAI.CustomToolChatCompletionsCustomFormatText

Nombre Tipo Description Obligatorio Predeterminado
type enum
Valores posibles: text		 Sí

OpenAI.FunctionObject

Nombre Tipo Description Obligatorio Predeterminado
description string Descripción de lo que hace la función, que usa el modelo para elegir cuándo y cómo llamar a la función. No
nombre string El nombre de la función que se llamará. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64. Sí
parameters OpenAI.FunctionParameters Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulta la guía para ejemplos y la referencia del esquema JSON para documentación sobre el formato.
La omisión parameters define una función con una lista de parámetros vacía.		 No
strict booleano o null No

OpenAI.FunctionParameters

Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulta la guía para ejemplos y la referencia del esquema JSON para documentación sobre el formato. La omisión parameters define una función con una lista de parámetros vacía.

Tipo: objeto

OpenAI.Metadata

Conjunto de 16 pares clave-valor que se pueden adjuntar a un objeto. Esto puede ser útil para almacenar información adicional sobre el objeto en un formato estructurado y consultar objetos a través de la API o el panel. Las claves son cadenas con una longitud máxima de 64 caracteres. Los valores son cadenas con una longitud máxima de 512 caracteres.

Tipo: objeto

OpenAI.ParallelToolCalls

Indica si se debe habilitar la llamada a funciones paralelas durante el uso de la herramienta.

Tipo: booleano

OpenAI.PredictionContent

Contenido estático

Contenido de salida predicho estático, como el contenido de un archivo de texto que se está regenerando.

Nombre Tipo Description Obligatorio Predeterminado
contenido cadena o matriz de OpenAI.ChatCompletionRequestMessageContentPartText El contenido que debe coincidir al generar una respuesta de modelo.
Si los tokens generados coinciden con este contenido, toda la respuesta del modelo
se puede devolver mucho más rápidamente.		 Sí
type enum Tipo del contenido previsto que desea proporcionar. Este tipo es
actualmente siempre content.
Valores posibles: content		 Sí

OpenAI.ReasoningEffort

Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos son none, minimal, low, medium, highy xhigh. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.

  • gpt-5.1 el valor predeterminado es none, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son none, low, mediumy high. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1.
  • Todos los modelos antes del gpt-5.1 esfuerzo de razonamiento predeterminado medium y no admiten none.
  • El gpt-5-pro modelo tiene como valor predeterminado (y solo admite) high el esfuerzo de razonamiento.
  • xhigh se admite para todos los modelos después gpt-5.1-codex-maxde .
Propiedad Value
Descripción Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Actualmente, los valores admitidos son none, minimal, low, medium, highy xhigh. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.
- gpt-5.1 el valor predeterminado es none, que no realiza el razonamiento. Los valores de razonamiento admitidos para gpt-5.1 son none, low, mediumy high. Las llamadas a herramientas se admiten para todos los valores de razonamiento en gpt-5.1.
- Todos los modelos antes gpt-5.1 del esfuerzo de razonamiento predeterminado medium y no admiten none.
- El gpt-5-pro modelo tiene como valor predeterminado (y solo admite) high el esfuerzo de razonamiento.
- xhigh se admite para todos los modelos después gpt-5.1-codex-maxde .
Type string
Valores none
minimal
low
medium
high
xhigh

OpenAI.ResponseFormatJsonSchema

Esquema JSON

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas. Aprende más sobre Structured Outputs.

Nombre Tipo Description Obligatorio Predeterminado
json_schema OpenAI.ResponseFormatJsonSchemaJsonSchema Sí
└─ Descripción string No
└─ Nombre string Sí
└─ Esquema OpenAI.ResponseFormatJsonSchemaSchema Esquema para el formato de respuesta, descrito como un objeto de esquema JSON.
Obtenga información sobre cómo compilar esquemas JSON aquí.		 No
└─ estricto booleano o null No
type enum Tipo de formato de respuesta que se va a definir. Siempre json_schema.
Valores posibles: json_schema		 Sí

OpenAI.ResponseFormatJsonSchemaJsonSchema

Nombre Tipo Description Obligatorio Predeterminado
description string No
nombre string Sí
schema OpenAI.ResponseFormatJsonSchemaSchema Esquema para el formato de respuesta, descrito como un objeto de esquema JSON.
Obtenga información sobre cómo compilar esquemas JSON aquí.		 No
strict booleano o null No

OpenAI.ResponseFormatJsonSchemaSchema

Esquema JSON

Esquema para el formato de respuesta, descrito como un objeto de esquema JSON. Obtenga información sobre cómo compilar esquemas JSON aquí.

Tipo: objeto

OpenAI.ResponseModalities

Tipos de salida que desea que genere el modelo. La mayoría de los modelos son capaces de generar texto, que es el valor predeterminado: ["text"] El gpt-4o-audio-preview modelo también se puede usar para generar audio. Para solicitar que este modelo genere respuestas de texto y audio, puede usar: ["text", "audio"]

Este esquema acepta uno de los siguientes tipos:

  • array
  • nulo

OpenAI.StopConfiguration

No se admite con los modelos más recientes de razonamiento o3 y o4-mini. Hasta 4 secuencias en las que la API dejará de generar más tokens. El texto devuelto no contendrá la secuencia de detención.

Este esquema acepta uno de los siguientes tipos:

  • array
  • nulo

OpenAI.Verbosity

Restringe el nivel de detalle de la respuesta del modelo. Los valores inferiores darán lugar a respuestas más concisas, mientras que los valores más altos darán lugar a respuestas más detalladas. Actualmente, los valores admitidos son low, mediumy high.

Propiedad Value
Descripción Restringe el nivel de detalle de la respuesta del modelo. Los valores inferiores darán lugar a respuestas más concisas, mientras que los valores más altos darán lugar a respuestas más detalladas. Actualmente, los valores admitidos son low, mediumy high.
Type string
Valores low
medium
high

OpenAI.VoiceIdsShared

Propiedad Value
Type string
Valores alloy
ash
ballad
coral
echo
sage
shimmer
verse
marin
cedar
  • Last updated on