Azure referencia de la versión preliminar de openAI en la API REST de Microsoft Foundry Models v1

En este artículo se proporcionan detalles sobre los puntos de conexión de la API REST de inferencia para Azure OpenAI.

Inferencia del plano de datos

El resto del artículo trata la nueva versión preliminar de la API v1 de la especificación de inferencia del plano de datos de OpenAI Azure. Obtenga más información en nuestra guía del ciclo de vida de la API.

Si busca documentación sobre la versión más reciente de la API de disponibilidad general v1, consulte la API de inferencia del plano de datos de disponibilidad general más reciente

Crear discurso

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

Genera audio de texto a voz a partir del texto de entrada.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		Versión explícita de la API de modelos de Microsoft Foundry que se va a usar para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	cuerda / cadena	Texto para el que se va a generar audio. La longitud máxima es de 4096 caracteres.	Sí
instructions	cuerda / cadena	Controle la voz del audio generado con instrucciones adicionales. No funciona con tts-1 o tts-1-hd.	No
modelo	cuerda / cadena	Modelo que se va a usar para esta solicitud de texto a voz.	Sí
formato_de_respuesta	objeto	Formatos de salida de audio admitidos para texto a voz.	No
speed	número	Velocidad del habla para el audio generado. Los valores son válidos en el intervalo de 0,25 a 4,0, con 1,0 los valores predeterminados y superiores correspondientes a una voz más rápida.	No	1
stream_format	enum	Formato en el que se va a transmitir el audio. Los formatos admitidos son sse y audio. sse no se admite para tts-1 o tts-1-hd. Valores posibles: sse, audio	No
voice	objeto		Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/octet-stream	cuerda / cadena

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Sintetiza el audio del texto proporcionado.

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

Respuestas: Código de estado: 200

{
  "body": "101010101"
}

Crear transcripción

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

Transcribe el audio en el idioma de entrada.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre	Tipo	Description	Obligatorio	Predeterminado
chunking_strategy	objeto		No
" prefix_padding_ms	entero	Cantidad de audio que se va a incluir antes de que el VAD detecte voz (en milisegundos).	No	300
└─ silencio_duración_ms	entero	Duración del silencio para detectar la detención de voz (en milisegundos). Con valores más cortos, el modelo responderá más rápidamente, pero puede saltar en pausas cortas del usuario.	No	200
└─ umbral	número	Umbral de sensibilidad (de 0,0 a 1,0) para la detección de actividad de voz. Un umbral superior requerirá audio más alto para activar el modelo y, por tanto, podría funcionar mejor en entornos ruidosos.	No	0,5
└─ Tipo	enum	Debe establecerse en server_vad para habilitar la fragmentación manual mediante VAD del lado servidor. Valores posibles: server_vad	No
archivo	cuerda / cadena		Sí
filename	cuerda / cadena	Nombre de archivo opcional o identificador descriptivo al que se va a asociar con los datos de audio.	No
include[]	array	Información adicional que se va a incluir en la respuesta de transcripción. logprobs devolverá las probabilidades logarítmicas de los tokens en la respuesta para comprender la confianza del modelo en la transcripción. logprobs solo funciona con response_format establecido en json y solo con los modelos gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe y gpt-4o-mini-transcribe-2025-12-15.	No
lenguaje	cuerda / cadena	El idioma del audio de entrada. Proporcionar el idioma de entrada en formato ISO-639-1 (por ejemplo, en) mejorará la precisión y la latencia.	No
modelo	cuerda / cadena	Modelo que se va a usar para esta solicitud de transcripción.	No
inmediato	cuerda / cadena	Texto opcional para guiar el estilo del modelo o continuar con un segmento de audio anterior. El mensaje debe coincidir con el idioma del audio.	No
formato_de_respuesta	objeto		No
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor. Nota: El streaming no se admite para el whisper-1 modelo y se omitirá.	No	Falso
temperatura	número	Temperatura de muestreo, entre 0 y 1. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Si se establece en 0, el modelo usará probabilidad logarítmica para aumentar la temperatura de forma automática hasta alcanzar ciertos umbrales.	No	0
timestamp_granularities[]	array	Granularidades de marca de tiempo que se van a rellenar para esta transcripción. response_format debe establecerse en verbose_json para usar granularidades de marca de tiempo. Se admiten una o ambas opciones: word o segment. Nota: No hay ninguna latencia adicional para las marcas de tiempo de segmento, pero la generación de marcas de tiempo de palabra incurre en una latencia adicional.	No	['segment']

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureAudioTranscriptionResponse
text/plain	cuerda / cadena

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Obtiene texto transcrito y metadatos asociados de los datos de audio hablados proporcionados.

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

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

Respuestas: Código de estado: 200

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

Crear traducción

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

Obtiene el texto transcrito en inglés y los metadatos asociados a partir de los datos de audio hablado proporcionados.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre	Tipo	Description	Obligatorio	Predeterminado
archivo	cuerda / cadena		Sí
filename	cuerda / cadena	Nombre de archivo opcional o identificador descriptivo al que se va a asociar con los datos de audio	No
modelo	cuerda / cadena	Modelo que se va a usar para esta solicitud de traducción.	No
inmediato	cuerda / cadena	Texto opcional para guiar el estilo del modelo o continuar con un segmento de audio anterior. La indicación debería ser en inglés.	No
formato_de_respuesta	objeto		No
temperatura	número	Temperatura de muestreo, entre 0 y 1. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Si se establece en 0, el modelo usará probabilidad logarítmica para aumentar la temperatura de forma automática hasta alcanzar ciertos umbrales.	No	0

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureAudioTranslationResponse
text/plain	cuerda / cadena

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Obtiene el texto transcrito en inglés y los metadatos asociados a partir de los datos de audio hablado proporcionados.

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

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

Respuestas: Código de estado: 200

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

Creación de la finalización del chat

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

Crea una finalización de chat.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
audio	objeto	Parámetros para la salida de audio. Obligatorio cuando se solicita la salida de audio con modalities: ["audio"].	No
└─ Formato	enum	Especifica el formato de audio de salida. Debe ser uno de los elementos wav, mp3, flacopuso pcm16. Valores posibles: wav, aac, mp3, flac, , opus, pcm16	No
└─ voz	objeto		No
data_sources	array	Los orígenes de datos que se van a usar para la característica En sus datos, exclusivos de Azure OpenAI.	No
frequency_penalty	número	Número entre 2.0 y 2.0. Los valores positivos penalizan los nuevos tokens en función de su frecuencia existente en el texto hasta el momento, disminuyendo la probabilidad del modelo de repetir la misma línea textualmente.	No	0
function_call	enum	Especificar una función determinada a través de {"name": "my_function"} obliga al modelo a llamar a esa función. Valores posibles: none, auto	No
functions	array	En desuso en favor de tools. Una lista de funciones para las que el modelo puede generar entradas JSON.	No
logit_bias	objeto	Modifica la probabilidad de que los tokens especificados aparezcan en la finalización. Acepta un objeto JSON que asigna tokens (especificados por su Id. de token en el tokenizador) 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á según el modelo, pero los valores entre -1 y 1 deberían disminuir o aumentar la probabilidad de selección; valores como -100 o 100 deberían dar lugar a una prohibición o selección exclusiva del token correspondiente.	No	Ninguno
logprobs	booleano	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	Falso
max_completion_tokens	entero	Límite superior del número de tokens que se pueden generar para una finalización, incluidos los tokens de razonamiento y los tokens de salida visibles.	No
max_tokens	entero	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 no es compatible con los modelos de la serie o1.	No
messages	array	Una lista de mensajes que componen la conversación hasta ahora. Según el modelo que use, se admiten diferentes tipos de mensajes (modalidades), como texto, imágenes y audio.	Sí
metadata	objeto	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.	No
modalidades	objeto	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 modelo gpt-4o-audio-preview también se puede usar para generar audio. Para solicitar que este modelo genere respuestas de texto y audio, puede usar: ["text", "audio"]	No
modelo	cuerda / cadena	Identificador de implementación del modelo que se va a usar para la solicitud de finalización del chat.	Sí
n	entero	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 como 1 para minimizar los costos.	No	1
parallel_tool_calls	objeto	Indica si se debe habilitar la llamada a funciones paralelas durante el uso de la herramienta.	No
prediction	objeto	Representación base de la salida predicha de un modelo.	No
└─ Tipo	OpenAI.ChatOutputPredictionType		No
presence_penalty	número	Número entre 2.0 y 2.0. Los valores positivos penalizan los nuevos tokens en función de su aparición en el texto hasta el momento, aumentando la probabilidad de que el modelo hable de nuevos temas.	No	0
esfuerzo de razonamiento	objeto	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
formato_de_respuesta	objeto		No
└─ Tipo	enum	Valores posibles: text, json_object, json_schema	No
seed	entero	Esta característica está en versión beta. Si se especifica, el sistema realizará un mejor esfuerzo para muestrear de manera determinista, de modo que las solicitudes repetidas con un mismo seed y parámetros deben devolver el mismo resultado. No se garantiza el determinismo y debe hacer referencia al parámetro de respuesta system_fingerprint para supervisar los cambios en el back-end.	No
stop	objeto	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.	No
store	booleano	Si desea almacenar o no la salida de esta solicitud de finalización de chat para su uso en productos de evaluación o destilación de modelos.	No	Falso
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor.	No	Falso
stream_options	objeto	Opciones para la respuesta de streaming. Establezca este valor solo cuando defina stream: true.	No
└─ incluir_uso	booleano	Si se establece, se transmitirá un fragmento adicional delante del mensaje data: [DONE]. El campo usage de este fragmento muestra las estadísticas de uso de tokens de toda la solicitud y el campo choices siempre será una matriz vacía. El resto de fragmentos también incluirá un campo usage, pero con un valor NULL. NOTA: Si se interrumpe la secuencia, es posible que no reciba el fragmento de uso final que contiene el uso total del token para la solicitud.	No
temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Controla la herramienta (si existe) a la que llama el modelo. 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"}} obliga 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
herramientas	array	Una lista de herramientas a las que puede llamar el modelo. Actualmente, solo se admiten funciones como una herramienta. Úselo para proporcionar una lista de funciones para las que el modelo puede generar entradas JSON. Se admite un máximo de 128 funciones.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No	1
user	cuerda / cadena	Identificador único que representa al usuario final, lo 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 for Cloud.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Crea una finalización para la indicación proporcionada, los parámetros y el modelo elegido.

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?"
  }
 ]
}

Respuestas: Código de estado: 200

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

Creación de inserción

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

Crea un vector de inserción que representa el texto de entrada.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
dimensions	entero	Número de dimensiones que deben tener las incrustaciones de salida resultantes. Solo se admite en modelos text-embedding-3 y versiones posteriores.	No
encoding_format	enum	Formato en el que se devuelven las incrustaciones. Puede ser float o base64. Valores posibles: float, base64	No
entrada	cadena o matriz		Sí
modelo	cuerda / cadena	Modelo que se va a usar para la solicitud de inserción.	Sí
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.CreateEmbeddingResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Devuelve las incrustaciones de un mensaje determinado.

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

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

Respuestas: Código de estado: 200

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

Enumeración de evaluaciones

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

Enumera las evaluaciones de un project.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
after	query	No	cuerda / cadena	Identificador de la última evaluación de la solicitud de paginación anterior.
limit	query	No	entero	Límite del número de evaluaciones que se van a devolver en una única respuesta de paginación.
order	query	No	cuerda / cadena Valores posibles: asc, desc	Criterio de ordenación de valores por marca de tiempo. Se usa asc para el orden ascendente o desc para el orden descendente.
ordenar_por	query	No	cuerda / cadena Valores posibles: created_at, updated_at	Las valoraciones se pueden ordenar por hora de creación o hora de última actualización. Use created_at para la hora de creación o updated_at para la hora de la última actualización.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalList

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Createeval

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

Cree la estructura de una evaluación que se puede usar para probar el rendimiento de un modelo.

Una evaluación es un conjunto de criterios de prueba y un origen de datos. Después de crear una evaluación, puede ejecutarla en diferentes modelos y parámetros de modelo. Se admiten varios tipos de calificadores y orígenes de datos.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
configuración_de_fuente_de_datos	objeto		Sí
└─ Tipo	OpenAI.EvalDataSourceConfigType		No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre de la evaluación.	No
código de estado	enum	Valores posibles: 201	Sí
criterios_de_prueba	array	Una lista de evaluadores para todas las ejecuciones de evaluación en este grupo. Los calificadores pueden hacer referencia a variables en el origen de datos mediante la notación de llaves, como {{item.variable_name}}. Para hacer referencia a la salida del modelo, use el espacio de nombres sample (es decir, {{sample.output_text}}).	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener evaluación

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

Recupere una evaluación por su identificador. Recupera una evaluación por su identificador.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Actualizar evaluación

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

Actualizar propiedades select, mutables de una evaluación especificada.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	OpenAI.MetadataPropertyForRequest	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.	No
nombre	cuerda / cadena		No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.Eval

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Eliminar evaluación

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

Elimine una evaluación especificada.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener ejecuciones de evaluación

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

Recupere una lista de ejecuciones para una evaluación especificada.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena
after	query	No	cuerda / cadena
limit	query	No	entero
order	query	No	cuerda / cadena Valores posibles: asc, desc
estado	query	No	cuerda / cadena Valores posibles: queued, in_progress, completed, , canceled, failed

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalRunList

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear una ejecución de evaluación

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

Cree una nueva ejecución de evaluación, lo que iniciará el proceso de calificación.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
fuente_de_datos	objeto		Sí
└─ Tipo	OpenAI.EvalRunDataSourceType		No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre de la ejecución.	No

Respuestas

Código de estado: 201

Descripción: la solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener ejecución de evaluación

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

Recupere una evaluación específica ejecutada por su identificador.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena
identificador_de_ejecución	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Cancelar ejecución de evaluación

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

Cancele una evaluación específica ejecutada por su identificador.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena
identificador_de_ejecución	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalRun

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Deleteevalrun

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

Elimine una evaluación específica ejecutada por su identificador.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena
identificador_de_ejecución	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener elementos de salida de ejecución de evaluación

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

Obtenga una lista de elementos de salida para una ejecución de evaluación especificada.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena
identificador_de_ejecución	ruta	Sí	cuerda / cadena
after	query	No	cuerda / cadena
limit	query	No	entero
estado	query	No	cuerda / cadena Valores posibles: fail, pass
order	query	No	cuerda / cadena Valores posibles: asc, desc

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalRunOutputItemList

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener elemento de salida de ejecución de evaluación

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

Recupere un elemento de salida específico de una evaluación ejecutada por su identificador.

NOTA: Esta Azure API de OpenAI está en versión preliminar y está sujeta a cambios.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
aoai-evals	encabezado	Sí	cuerda / cadena Valores posibles: preview	Habilita access a AOAI Evals, una característica en versión preliminar. Esta característica requiere que el encabezado "aoai-evals" se establezca en "preview".
eval_id	ruta	Sí	cuerda / cadena
identificador_de_ejecución	ruta	Sí	cuerda / cadena
output_item_id	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.EvalRunOutputItem

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear archivo

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre	Tipo	Description	Obligatorio	Predeterminado
expires_after	objeto		Sí
└─ delimitador	AzureFileExpiryAnchor		No
└─ segundos	entero		No
archivo	cuerda / cadena		Sí
finalidad	enum	El propósito previsto del archivo cargado. Uno de los siguientes: - assistants: se usa en la API de asistentes - batch: se usa en Batch API - fine-tune: se usa para la optimización - evals: se usa para conjuntos de datos de evaluación Valores posibles: assistants, batch, fine-tune, evals	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIFile

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

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

Enumerar archivos

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
finalidad	query	No	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureListFilesResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Recuperar archivo

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
ID del archivo	ruta	Sí	cuerda / cadena	Identificador del archivo que se va a usar para esta solicitud.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIFile

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Eliminar archivo

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
ID del archivo	ruta	Sí	cuerda / cadena	Identificador del archivo que se va a usar para esta solicitud.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.DeleteFileResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Descargar archivo

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
ID del archivo	ruta	Sí	cuerda / cadena	Identificador del archivo que se va a usar para esta solicitud.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/octet-stream	cuerda / cadena

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Rungrader

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

Ejecute un evaluador.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	No
└─ evaluadores	objeto		No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	No
item		Elemento de conjunto de datos proporcionado al evaluador. Se usará para rellenar el item espacio de nombres.	No
model_sample	cuerda / cadena	Ejemplo de modelo que se va a evaluar. Este valor se usará para rellenar el sample espacio de nombres. La output_json variable se rellenará si el ejemplo de modelo es una cadena JSON válida.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.RunGraderResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Validar evaluador

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

Valide un evaluador.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	No
└─ evaluadores	objeto		No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ValidateGraderResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear un trabajo de ajuste preciso

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

Crea un trabajo de ajuste preciso que comienza el proceso de creación de un nuevo modelo a partir de un conjunto de datos determinado.

La respuesta incluye detalles del trabajo en cola, incluido el estado del trabajo y el nombre de los modelos ajustados una vez completados.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	objeto	Hiperparámetros usados para el trabajo de ajuste preciso. Este valor ahora está en desuso en favor de method y debe pasarse bajo el parámetro method.	No
└─ tamaño del lote (batch_size)	enum	Valores posibles: auto	No
"└─ learning_rate_multiplier"	enum	Valores posibles: auto	No
├─ n_epochs	enum	Valores posibles: auto	No
Integraciones	array	Lista de integraciones que se habilitarán para el trabajo de ajuste preciso.	No
metadata	objeto	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.	No
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
modelo	string (consulte los modelos válidos a continuación)	Nombre del modelo que se va a ajustar.	Sí
seed	entero	La semilla controla la reproducibilidad del trabajo. Pasar los mismos parámetros de inicialización y trabajo debe generar los mismos resultados, pero puede diferir en raras ocasiones. Si no se especifica una semilla, se generará una para ti.	No
sufijo	cuerda / cadena	Cadena de hasta 64 caracteres que se agregarán al nombre del modelo ajustado. Por ejemplo, un suffix de "custom-model-name" produciría un nombre de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	No	Ninguno
archivo_de_entrenamiento	cuerda / cadena	Identificador de un archivo cargado que contiene datos de entrenamiento. El conjunto de datos debe tener el formato JSONL. Además, debe cargar su archivo con el propósito de fine-tune. El contenido del archivo debe diferir en función de si el modelo usa el formato de chat, finalizaciones o si el método de ajuste utiliza el formato de preferencia.	Sí
archivo_de_validación	cuerda / cadena	El Id. de un archivo cargado que contenga datos de validación. Si proporciona este archivo, los datos se usan para generar métricas de validación periódicamente durante el ajuste fino. Estas métricas se pueden ver en el archivo de resultados de ajuste fino. Los mismos datos no deben estar presentes en los archivos de entrenamiento y validación. El conjunto de datos debe tener el formato de un archivo JSONL. Debe cargar el archivo con el propósito fine-tune.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.FineTuningJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumerar trabajos de ajuste paginado

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

Enumerar los trabajos de ajuste preciso de la organización

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
after	query	No	cuerda / cadena	Identificador del último trabajo de la solicitud de paginación anterior.
limit	query	No	entero	Número de trabajos de ajuste preciso que se van a recuperar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Recuperar trabajo de ajuste preciso

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

Obtenga información sobre un trabajo de ajuste preciso.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.FineTuningJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Cancelar trabajo de ajuste preciso

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

Cancele inmediatamente un trabajo de ajuste.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste que se va a cancelar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.FineTuningJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumerar puntos de comprobación de un trabajos de ajuste

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

Enumere los puntos de comprobación de un trabajo de ajuste.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso para el que se van a obtener puntos de comprobación.
after	query	No	cuerda / cadena	Identificador del último id. de punto de comprobación de la solicitud de paginación anterior.
limit	query	No	entero	Número de puntos de comprobación que se van a recuperar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumeración de eventos de ajuste preciso

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

Obtenga actualizaciones de estado para un trabajo de ajuste preciso.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso para el que se van a obtener eventos.
after	query	No	cuerda / cadena	Identificador del último evento de la solicitud de paginación anterior.
limit	query	No	entero	Número de eventos que se van a recuperar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListFineTuningJobEventsResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Pausar el trabajo de ajuste preciso

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

Pause un trabajo de ajuste.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso que se va a pausar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.FineTuningJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Reanudar trabajo de ajuste

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

Reanude un trabajo de ajuste en pausa.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
fine_tuning_job_id	ruta	Sí	cuerda / cadena	Identificador del trabajo de ajuste preciso que se va a reanudar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.FineTuningJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear edición de imágenes

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Permite establecer transparencia para el fondo de las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de transparent, opaque o auto (valor predeterminado). Cuando auto se usa, el modelo determinará automáticamente el mejor fondo para la imagen. Si transparent es, el formato de salida debe admitir la transparencia, por lo que debe establecerse en png (valor predeterminado) o webp. Valores posibles: transparent, opaque, auto	No
imagen	cadena o matriz		Sí
máscara	cuerda / cadena		No
modelo	cuerda / cadena	Implementación del modelo que se va a usar para la operación de edición de imágenes.	Sí
n	entero	Número de imágenes que se van a generar. Debe estar entre 1 y 10.	No	1
compresión_de_salida	entero	Nivel de compresión (0-100%) para las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1 con los formatos de salida webp o jpeg, y el valor predeterminado es 100.	No	100
formato_de_salida	enum	Formato en el que se devuelven las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de los siguientes valores: png, jpeg o webp. El valor predeterminado es png. Valores posibles: png, jpeg, webp	No
inmediato	cuerda / cadena	Descripción de texto de las imágenes deseadas. La longitud máxima es de 1000 caracteres para dall-e-2, y 32000 caracteres para gpt-image-1los modelos de serie .	Sí
calidad	enum	Calidad de la imagen que se generará. high, medium y low solo se admiten para los modelos de la serie gpt-image-1. dall-e-2 solo soporta la calidad standard. Tiene como valor predeterminado auto. Valores posibles: standard, low, medium, , high, auto	No
formato_de_respuesta	enum	Formato en el que se devuelven las imágenes generadas. Debe ser uno de url o b64_json. Las direcciones URL solo son válidas durante 60 minutos después de que se haya generado la imagen. Este parámetro solo se admite para dall-e-2, ya gpt-image-1que los modelos de serie siempre devolverán imágenes codificadas en base64. Valores posibles: url, b64_json	No
tamaño	enum	Tamaño de las imágenes generadas. Debe ser uno de 1024x1024, 1536x1024 (horizontal), 1024x1536 (vertical) o auto (valor predeterminado) para los modelos de la serie gpt-image-1, y uno de 256x256, 512x512 o 1024x1024 para dall-e-2. Valores posibles: 256x256, 512x512, 1024x1024, 1536x1024, , 1024x1536, auto	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureImagesResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Createimage

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Permite establecer transparencia para el fondo de las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de transparent, opaque o auto (valor predeterminado). Cuando auto se usa, el modelo determinará automáticamente el mejor fondo para la imagen. Si transparent es, el formato de salida debe admitir la transparencia, por lo que debe establecerse en png (valor predeterminado) o webp. Valores posibles: transparent, opaque, auto	No
modelo	cuerda / cadena	Implementación del modelo que se va a usar para la generación de imágenes.	Sí
moderation	enum	Controle el nivel de moderación de contenido para las imágenes generadas por modelos de la serie gpt-image-1. Debe ser low para un filtrado menos restrictivo o auto (valor predeterminado). Valores posibles: low, auto	No
n	entero	Número de imágenes que se van a generar. Debe estar entre 1 y 10. Para dall-e-3, solo n=1 se admite.	No	1
compresión_de_salida	entero	Nivel de compresión (0-100%) para las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1 con los formatos de salida webp o jpeg, y el valor predeterminado es 100.	No	100
formato_de_salida	enum	Formato en el que se devuelven las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de los siguientes valores: png, jpeg o webp. Valores posibles: png, jpeg, webp	No
inmediato	cuerda / cadena	Descripción de texto de las imágenes deseadas. La longitud máxima es de 32000 caracteres para gpt-image-1 de la serie, 1000 caracteres para dall-e-2 y 4000 caracteres para dall-e-3.	Sí
calidad	enum	Calidad de la imagen que se generará. - auto (valor predeterminado) seleccionará automáticamente la mejor calidad para el modelo especificado. - high, medium y low son compatibles para los modelos de la serie gpt-image-1. - hd y standard son compatibles con dall-e-3. - standard es la única opción para dall-e-2. Valores posibles: standard, hd, low, medium, , high, auto	No
formato_de_respuesta	enum	Formato en el que se devuelven las imágenes generadas con dall-e-2 y dall-e-3 . Debe ser uno de url o b64_json. Las direcciones URL solo son válidas durante 60 minutos después de que se haya generado la imagen. Este parámetro no es compatible con los modelos de la serie gpt-image-1, los cuales siempre devolverán imágenes codificadas en base64. Valores posibles: url, b64_json	No
tamaño	enum	Tamaño de las imágenes generadas. Debe ser uno de 1024x1024, 1536x1024 (horizontal), 1024x1536 (vertical) o auto (valor predeterminado) para gpt-image-1, modelos de la serie, uno de 256x256, 512x512, o 1024x1024 para dall-e-2, y uno de 1024x1024, 1792x1024, o 1024x1792 para dall-e-3. Valores posibles: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, , , 1792x10241024x1792	No
style	enum	Estilo de las imágenes generadas. Este parámetro solamente se admite en dall-e-3. Debe ser uno de vivid o natural. Vívido hace que el modelo se inclina hacia la generación de imágenes hiper-reales y dramáticas. Natural permite que el modelo produzca imágenes más naturales, menos hiperrealistas. Valores posibles: vivid, natural	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureImagesResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Crea imágenes a partir de una indicación.

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

Respuestas: Código de estado: 200

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

Enumeración de modelos

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

Enumera los modelos disponibles actualmente y proporciona información básica sobre cada uno de ellos, como el propietario y la disponibilidad.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListModelsResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Recuperar modelo

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

Recupera una instancia de modelo, lo que proporciona información básica sobre el modelo, como el propietario y el permiso.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
modelo	ruta	Sí	cuerda / cadena	Identificador del modelo que se va a usar para esta solicitud.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.Model

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear respuesta

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

Crea una respuesta modelo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
incluir	array	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Los valores admitidos actualmente son: - code_interpreter_call.outputs: incluye las salidas de la ejecución de código de Python en los elementos de llamada de la herramienta de intérprete de código. - computer_call_output.output.image_url: incluya direcciones URL de imagen desde la salida de la llamada del equipo. - file_search_call.results: incluya los resultados de búsqueda de la llamada a la herramienta de búsqueda de archivos. - message.input_image.image_url: incluya las URL de las imágenes del mensaje de entrada. - message.output_text.logprobs: incluya logprobs con mensajes de asistente. - reasoning.encrypted_content: incluye una versión cifrada de tokens de razonamiento en las salidas del elemento de razonamiento. Esto permite que los elementos de razonamiento se utilicen en conversaciones multiturno cuando se utiliza la API de Respuestas de manera sin estado (como cuando el store parámetro está configurado en false, o cuando una organización está inscrita en el programa de cero retención de datos).	No
entrada	cadena o matriz		No
instructions	cuerda / cadena	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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.	No
modelo	cuerda / cadena	Implementación del modelo que se va a usar para la creación de esta respuesta.	Sí
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
inmediato	objeto	Referencia a una plantilla de solicitud y sus variables.	No
└─ id.	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	No
Variables └	OpenAI.ResponsePromptVariables	Asignación opcional de valores para sustituir por variables en la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.	No
└─ versión	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
└─ generar_resumen	enum	En desuso: use summary en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
store	booleano	Si se va a almacenar la respuesta del modelo generada para su recuperación posterior a través de la API.	No	Cierto
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor.	No	Falso
temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No	1
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	objeto	Controla la herramienta (si existe) a la que llama el modelo. 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.	No
└─ Tipo	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Tú puede especificar qué herramienta se va a usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo, como la búsqueda de archivos. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, lo que permite que el modelo llame a su propio código.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No	1
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Example

Creación de una respuesta de modelo

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

Obtener respuesta

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

Recupera una respuesta de modelo con el identificador especificado.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
response_id	ruta	Sí	cuerda / cadena
include[]	query	No	array

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	AzureResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Eliminar respuesta

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

Elimina una respuesta por identificador.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
response_id	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	objeto

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumerar elementos de entrada

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

Devuelve una lista de elementos de entrada para una respuesta determinada.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
response_id	ruta	Sí	cuerda / cadena
limit	query	No	entero	Límite en el número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.
order	query	No	cuerda / cadena Valores posibles: asc, desc	Criterio de ordenación por la created_at marca de tiempo de los objetos. asc para orden ascendente ydesc para orden descendente.
after	query	No	cuerda / cadena	Cursor para su uso en la paginación. after es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos que terminan en obj_foo, su llamada posterior puede incluir after=obj_foo para recuperar la siguiente página de la lista.
before	query	No	cuerda / cadena	Cursor para su uso en la paginación. before es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ResponseItemList

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumerar almacenes de vectores

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

Devuelve una lista de almacenes vectoriales.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
limit	query	No	entero	Límite en el número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.
order	query	No	cuerda / cadena Valores posibles: asc, desc	Criterio de ordenación por la created_at marca de tiempo de los objetos. asc para orden ascendente ydesc para orden descendente.
after	query	No	cuerda / cadena	Cursor para su uso en la paginación. after es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos que terminan en obj_foo, su llamada posterior puede incluir after=obj_foo para recuperar la siguiente página de la lista.
before	query	No	cuerda / cadena	Cursor para su uso en la paginación. before es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListVectorStoresResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Creación de un almacén de vectores

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

Crea un almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
chunking_strategy	objeto	Estrategia predeterminada. Actualmente, esta estrategia usa un max_chunk_size_tokens de 800 y chunk_overlap_tokens de 400.	No
└─ estático	OpenAI.StaticChunkingStrategy		No
└─ Tipo	enum	Siempre static. Valores posibles: static	No
expires_after	OpenAI.VectorStoreExpirationAfter	Directiva de expiración de un almacén de vectores.	No
identificadores de archivos	array	Lista de identificadores de archivo que debe usar el almacén de vectores. Útil para herramientas como file_search que pueden access archivos.	No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre del almacén de vectores.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Examples

Archivo de ejemplo no encontrado: ./examples/vector_stores.json

Obtener almacén de vectores

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

Recupera un almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores que se va a recuperar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Modificar almacén de vectores

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

Modifica un almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Id. del almacén de vectores que se va a modificar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
expires_after	objeto	Directiva de expiración de un almacén de vectores.	No
└─ delimitador	enum	Marca de tiempo de anclaje después de la cual se aplica la directiva de expiración. Anclajes admitidos: last_active_at. Valores posibles: last_active_at	No
└─ días	entero	Número de días después del tiempo de delimitador que expirará el almacén de vectores.	No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre del almacén de vectores.	No

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Eliminar almacén de vectores

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

Borrar un almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores que se va a eliminar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.DeleteVectorStoreResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear un lote de archivos de almacén de vectores

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

Cree un lote de archivos de almacén vectorial.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores para el que se va a crear un lote de archivos.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Estrategia de fragmentación usada para fragmentar los archivos. Si no se establece, usará la estrategia auto.	No
identificadores de archivos	array	Lista de identificadores de archivo que debe usar el almacén de vectores. Útil para herramientas como file_search que pueden access archivos.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreFileBatchObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener lote de archivos del almacén de vectores

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

Recupera un lote de archivos de almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores al que pertenece el lote de archivo.
batch_id	ruta	Sí	cuerda / cadena	Identificador del lote de archivo que se va a recuperar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreFileBatchObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Cancelar el lote de archivos del almacén de vectores

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

Cancelar un lote de archivos de almacén de vectores. Esto intenta cancelar el procesamiento de archivos en este lote lo antes posible.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores al que pertenece el lote de archivo.
batch_id	ruta	Sí	cuerda / cadena	Identificador del lote de archivo que se va a cancelar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreFileBatchObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumerar archivos en el lote del almacén de vectores

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

Devuelve una lista de archivos de almacén de vectores en un lote.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores al que pertenece el lote de archivo.
batch_id	ruta	Sí	cuerda / cadena	Identificador del lote de archivo al que pertenecen los archivos.
limit	query	No	entero	Límite en el número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.
order	query	No	cuerda / cadena Valores posibles: asc, desc	Criterio de ordenación por la created_at marca de tiempo de los objetos. asc para orden ascendente ydesc para orden descendente.
after	query	No	cuerda / cadena	Cursor para su uso en la paginación. after es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos que terminan en obj_foo, su llamada posterior puede incluir after=obj_foo para recuperar la siguiente página de la lista.
before	query	No	cuerda / cadena	Cursor para su uso en la paginación. before es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.
filtro	query	No		Filtre por estado de archivo. Uno de in_progress, completed, failed, cancelled.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListVectorStoreFilesResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Enumerar archivos de almacén de vectores

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

Devuelve una lista de archivos de almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores al que pertenecen los archivos.
limit	query	No	entero	Límite en el número de objetos que se van a devolver. El límite puede oscilar entre 1 y 100 y el valor predeterminado es 20.
order	query	No	cuerda / cadena Valores posibles: asc, desc	Criterio de ordenación por la created_at marca de tiempo de los objetos. asc para orden ascendente ydesc para orden descendente.
after	query	No	cuerda / cadena	Cursor para su uso en la paginación. after es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos que terminan en obj_foo, su llamada posterior puede incluir after=obj_foo para recuperar la siguiente página de la lista.
before	query	No	cuerda / cadena	Cursor para su uso en la paginación. before es un identificador de objeto que define su lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.
filtro	query	No		Filtre por estado de archivo. Uno de in_progress, completed, failed, cancelled.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.ListVectorStoreFilesResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Crear un archivo de almacén de vectores

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

Cree un archivo de almacén de vectores adjuntando un archivo a un almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores para el que se va a crear un archivo.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Estrategia de fragmentación usada para fragmentar los archivos. Si no se establece, usará la estrategia auto.	No
ID del archivo	cuerda / cadena	Identificador de archivo que debe usar el almacén de vectores. Útil para herramientas como file_search que pueden access archivos.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreFileObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Obtener archivo de almacén de vectores

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

Recupera un archivo de almacén de vectores.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores al que pertenece el archivo.
ID del archivo	ruta	Sí	cuerda / cadena	Identificador del archivo que se va a recuperar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreFileObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Actualizar atributos de archivo de almacén de vectores

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

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena
ID del archivo	ruta	Sí	cuerda / cadena

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.VectorStoreFileObject

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Eliminar archivo de almacén de vectores

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

Elimine un archivo de almacén de vectores. Esto quitará el archivo del almacén de vectores, pero el propio archivo no se eliminará. Para eliminar el archivo, use el punto de conexión eliminar archivo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
vector_store_id	ruta	Sí	cuerda / cadena	Identificador del almacén de vectores al que pertenece el archivo.
ID del archivo	ruta	Sí	cuerda / cadena	Identificador del archivo que se va a eliminar.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	OpenAI.DeleteVectorStoreFileResponse

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureErrorResponse

Trabajos de generación de vídeo: crear

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

Crea un nuevo trabajo de generación de vídeos.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Cuerpo de la solicitud

Tipo-Contenido: application/json

Nombre	Tipo	Description	Obligatorio	Predeterminado
altura	entero	Alto del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí
modelo	cuerda / cadena	Nombre de la implementación que se va a usar para esta solicitud.	Sí
n_seconds	entero	Duración del trabajo de generación de vídeo. Debe estar entre 1 y 20 segundos.	No	5
n_variants	entero	Número de vídeos que se van a crear como variantes para este trabajo. Debe estar entre 1 y 5. Las dimensiones más pequeñas permiten más variantes.	No	1
inmediato	cuerda / cadena	Solicitud de este trabajo de generación de vídeo.	Sí
Ancho	entero	Ancho del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí

Cuerpo de la solicitud

Tipo de contenido: varias partes/datos de formulario

Nombre	Tipo	Description	Obligatorio	Predeterminado
files	array		Sí
altura	entero	Alto del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí
inpaint_items	array	Elementos opcionales de inpainting para este trabajo de generación de vídeo.	No
modelo	cuerda / cadena	Nombre de la implementación que se va a usar para esta solicitud.	Sí
n_seconds	entero	Duración del trabajo de generación de vídeo. Debe estar entre 1 y 20 segundos.	No	5
n_variants	entero	Número de vídeos que se van a crear como variantes para este trabajo. Debe estar entre 1 y 5. Las dimensiones más pequeñas permiten más variantes.	No	1
inmediato	cuerda / cadena	Solicitud de este trabajo de generación de vídeo.	Sí
Ancho	entero	Ancho del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	VideoGenerationJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

Archivo de ejemplo no encontrado: ./examples/create_video_generation_job_simple.json

Trabajos de generación de vídeo: lista

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

Enumera los trabajos de generación de vídeo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
before	query	No	cuerda / cadena
after	query	No	cuerda / cadena
limit	query	Sí	entero
statuses	query	No	array

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	VideoGenerationJobList

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

Archivo de ejemplo no encontrado: ./examples/get_video_generation_job_list.json

Trabajos de generación de vídeo: Obtener

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

Recupera las propiedades de un trabajo de generación de vídeo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
job-id	ruta	Sí	cuerda / cadena	Identificador del trabajo de generación de vídeo que se va a usar para la solicitud openAI de Azure.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	VideoGenerationJob

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

Archivo de ejemplo no encontrado: ./examples/get_video_generation_job.json

Trabajos de generación de vídeo: eliminar

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

Elimina un trabajo de generación de vídeo.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
job-id	ruta	Sí	cuerda / cadena	Identificador del trabajo de generación de vídeo que se va a usar para la solicitud openAI de Azure.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 204

Descripción: no hay contenido que enviar para esta solicitud, pero los encabezados pueden ser útiles.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Generaciones de vídeo: Obtener

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

Recupera una generación de vídeo por identificador.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
generation-id	ruta	Sí	cuerda / cadena	Identificador de la generación de vídeo que se va a usar para la solicitud de OpenAI de Azure.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
application/json	VideoGeneration

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

Archivo de ejemplo no encontrado: ./examples/get_video_generation.json

Generaciones de vídeo: recuperación de miniaturas

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

Recupera una miniatura del contenido de vídeo generado.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
generation-id	ruta	Sí	cuerda / cadena	Identificador de la generación de vídeo que se va a usar para la solicitud de OpenAI de Azure.

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
image/jpg	cuerda / cadena

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Generaciones de vídeo: recuperación del contenido de vídeo

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

Recupera el contenido de vídeo generado.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
generation-id	ruta	Sí	cuerda / cadena	Identificador de la generación de vídeo que se va a usar para la solicitud de OpenAI de Azure.
calidad	query	No

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Tipo de contenido	Tipo	Descripción
video/mp4	cuerda / cadena

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Generaciones de vídeo: solo recuperación de encabezados de vídeocontent

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

Recupera encabezados para el contenido de vídeo generado.

Parámetros de URI

Nombre	En	Obligatorio	Tipo	Description
endpoint	ruta	Sí	cuerda / cadena URL	Se admiten Azure puntos de conexión de OpenAI (protocolo y nombre de host, por ejemplo: https://aoairesource.openai.azure.com. Reemplace "aoairesource" por el nombre del recurso de OpenAI de Azure). https://{your-resource-name}.openai. azure.com
versión de la API	query	No		La versión explícita de Foundry Models API que se utilizará para esta solicitud. v1 si no se especifica lo contrario.
generation-id	ruta	Sí	cuerda / cadena	Identificador de la generación de vídeo que se va a usar para la solicitud de OpenAI de Azure.
calidad	query	No

Encabezado de solicitud

Use la autenticación basada en tokens o la clave de API. La autenticación con autenticación basada en tokens se recomienda y es más segura.

Nombre	Obligatorio	Tipo	Description
Authorization	Cierto	cuerda / cadena	Ejemplo:Authorization: Bearer {Azure_OpenAI_Auth_Token} Para generar un token de autenticación mediante Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Tipo: oauth2 Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize alcance: https://ai.azure.com/.default
clave de API	Cierto	cuerda / cadena	Proporcione Azure clave de API de OpenAI aquí

Respuestas

Código de estado: 200

Descripción: la solicitud se ha realizado correctamente.

Código de estado: valor predeterminado

Descripción: una respuesta de error inesperada.

Tipo de contenido	Tipo	Descripción
application/json	AzureOpenAIVideoGenerationErrorResponse

Componentes

AudioTaskLabel

Define los posibles descriptores para las respuestas de operación de audio disponibles.

Propiedad	Importancia
Descripción	Define los posibles descriptores para las respuestas de operación de audio disponibles.
Tipo	cuerda / cadena
Valores	transcribe translate

AudioTranslationSegment

Información extendida sobre un único segmento de datos de audio traducidos. Los segmentos suelen representar aproximadamente entre 5 y 10 segundos de voz. Normalmente, los límites de segmento se producen entre palabras, pero no necesariamente entre oraciones.

Nombre	Tipo	Description	Obligatorio	Predeterminado
avg_logprob	número	Probabilidad media del registro asociada a este segmento de audio.	Sí
compression_ratio	número	Razón de compresión de este segmento de audio.	Sí
fin	número	Hora en la que este segmento finalizó con respecto al principio del audio traducido.	Sí
id	entero	Índice basado en 0 de este segmento dentro de una traducción.	Sí
no_speech_prob	número	Probabilidad de que no haya detección de voz en este segmento de audio.	Sí
seek	entero	Posición de búsqueda asociada al procesamiento de este segmento de audio. Las posiciones de búsqueda se expresan como centésimas de segundos. El modelo puede procesar varios segmentos desde una sola posición de búsqueda, por lo que, aunque la posición de búsqueda nunca representará un tiempo posterior al inicio del segmento, el inicio del segmento puede representar un tiempo significativamente posterior a la posición de búsqueda asociada del segmento.	Sí
inicio	número	Hora en la que se inició este segmento en relación con el principio del audio traducido.	Sí
temperatura	número	Puntuación de temperatura asociada a este segmento de audio.	Sí
texto	cuerda / cadena	Texto traducido que formaba parte de este segmento de audio.	Sí
tokens	array	Identificadores de token que coinciden con el texto traducido en este segmento de audio.	Sí

AzureAIFoundryModelsApiVersion

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	v1 preview

AzureAudioTranscriptionResponse

Información de resultados de una operación que transcribió el audio hablado en texto escrito.

Nombre	Tipo	Description	Obligatorio	Predeterminado
duración	número	Duración total del audio procesado para generar información de transcripción complementaria.	No
lenguaje	cuerda / cadena	Idioma hablado que se detectó en los datos de audio transcritos. Esto se expresa como un código de lenguaje ISO-639-1 de dos letras, como "en" o "fr".	No
segments	array	Colección de información sobre el tiempo, las probabilidades y otros detalles de cada segmento de audio procesado.	No
task	objeto	Define los posibles descriptores para las respuestas de operación de audio disponibles.	No
texto	cuerda / cadena	Texto transcrito para los datos de audio proporcionados.	Sí
words	array	Colección de información sobre el tiempo de cada palabra procesada.	No

AzureAudioTranslationResponse

Información de resultados de una operación que traducía el audio hablado en texto escrito.

Nombre	Tipo	Description	Obligatorio	Predeterminado
duración	número	Duración total del audio procesado para generar información de traducción complementaria.	No
lenguaje	cuerda / cadena	Idioma hablado que se detectó en los datos de audio traducidos. Esto se expresa como un código de lenguaje ISO-639-1 de dos letras, como "en" o "fr".	No
segments	array	Colección de información sobre el tiempo, las probabilidades y otros detalles de cada segmento de audio procesado.	No
task	objeto	Define los posibles descriptores para las respuestas de operación de audio disponibles.	No
texto	cuerda / cadena	Texto traducido para los datos de audio proporcionados.	Sí

AzureChatCompletionResponseMessage

Componente del modelo de respuesta extendida para mensajes de respuesta de finalización de chat en el Azure OpenAI service. Este modelo añade compatibilidad con el contexto del mensaje de chat, utilizado por la función On Your Data para la intención, las citas y otra información relacionada con la generación aumentada por recuperación realizada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
Anotaciones	array	Anotaciones para el mensaje, cuando proceda, como cuando se usa la herramienta de búsqueda web.	No
audio	objeto	Si se solicita la modalidad de salida de audio, este objeto contiene datos sobre la respuesta de audio del modelo.	No
└─ datos	cuerda / cadena	Bytes de audio codificados en Base64 generados por el modelo, en el formato especificado en la solicitud.	No
expires_at	entero	La marca de tiempo de Unix (en segundos) que indica el momento en que esta respuesta de audio dejará de ser accesible en el servidor para su uso en conversaciones de múltiples turnos.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta de audio.	No
└─ transcripción	cuerda / cadena	Transcripción del audio generado por el modelo.	No
contenido	cuerda / cadena	Contenido del mensaje.	Sí
context	objeto	Una propiedad adicional, agregada a los mensajes de respuesta de finalización del chat, generados por el Azure OpenAI service al usar el comportamiento de la extensión. Esto incluye la intención y la información de cita de la característica En los datos.	No
└─ todos_los_documentos_recuperados	objeto	Información de resumen sobre los documentos recuperados por la operación de recuperación de datos.	No
└" chunk_id	cuerda / cadena	Identificador del fragmento de la cita.	No
└─ Contenido	cuerda / cadena	Contenido de la cita.	No
└─ índice_fuente_datos	entero	Índice del origen de datos usado para la recuperación.	No
└─ ruta de archivo	cuerda / cadena	Ruta de archivo para la referencia.	No
└─ razón_del_filtro	enum	Si procede, indica por qué se filtre el documento. Valores posibles: score, rerank	No
└" original_search_score	número	Puntuación de búsqueda original para la recuperación.	No
└" rerank_score	número	Puntuación de reordenamiento para la recuperación.	No
└─ consultas_de_búsqueda	array	Las consultas de búsqueda ejecutadas para recuperar documentos.	No
└─ Título	cuerda / cadena	Título de la cita.	No
└─ URL	cuerda / cadena	Dirección URL de la cita.	No
└─ citas	array	Las citas producidas por la recuperación de datos.	No
└─ Intención	cuerda / cadena	La intención detectada del historial de chat, que se usa para mantener el contexto de la conversación entre interacciones.	No
function_call	objeto	En desuso y reemplazado por tool_calls. Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo.	No
└ Argumentos	cuerda / cadena		No
└─ Nombre	cuerda / cadena		No
reasoning_content	cuerda / cadena	Propiedad de extensión Azure específica que contiene contenido de razonamiento generado a partir de modelos admitidos.	No
refusal	cuerda / cadena	Mensaje de denegación generado por el modelo.	Sí
role	enum	Rol del autor de este mensaje. Valores posibles: assistant	Sí
tool_calls	ChatCompletionMessageToolCallsItem	Llamadas a herramientas generadas por el modelo, como las llamadas a funciones.	No

AzureChatCompletionStreamResponseDelta

Modelo de respuesta extendida para un mensaje de respuesta de chat en streaming en el Azure OpenAI service. Este modelo añade compatibilidad con el contexto del mensaje de chat, utilizado por la función On Your Data para la intención, las citas y otra información relacionada con la generación aumentada por recuperación realizada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
audio	objeto		No
└─ datos	cuerda / cadena		No
expires_at	entero		No
└─ id.	cuerda / cadena		No
└─ transcripción	cuerda / cadena		No
contenido	cuerda / cadena	Contenido del fragmento del mensaje.	No
context	objeto	Una propiedad adicional, agregada a los mensajes de respuesta de finalización del chat, generados por el Azure OpenAI service al usar el comportamiento de la extensión. Esto incluye la intención y la información de cita de la característica En los datos.	No
└─ todos_los_documentos_recuperados	objeto	Información de resumen sobre los documentos recuperados por la operación de recuperación de datos.	No
└" chunk_id	cuerda / cadena	Identificador del fragmento de la cita.	No
└─ Contenido	cuerda / cadena	Contenido de la cita.	No
└─ índice_fuente_datos	entero	Índice del origen de datos usado para la recuperación.	No
└─ ruta de archivo	cuerda / cadena	Ruta de archivo para la referencia.	No
└─ razón_del_filtro	enum	Si procede, indica por qué se filtre el documento. Valores posibles: score, rerank	No
└" original_search_score	número	Puntuación de búsqueda original para la recuperación.	No
└" rerank_score	número	Puntuación de reordenamiento para la recuperación.	No
└─ consultas_de_búsqueda	array	Las consultas de búsqueda ejecutadas para recuperar documentos.	No
└─ Título	cuerda / cadena	Título de la cita.	No
└─ URL	cuerda / cadena	Dirección URL de la cita.	No
└─ citas	array	Las citas producidas por la recuperación de datos.	No
└─ Intención	cuerda / cadena	La intención detectada del historial de chat, que se usa para mantener el contexto de la conversación entre interacciones.	No
function_call	objeto	En desuso y reemplazado por tool_calls. Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo.	No
└ Argumentos	cuerda / cadena		No
└─ Nombre	cuerda / cadena		No
reasoning_content	cuerda / cadena	Propiedad de extensión Azure específica que contiene contenido de razonamiento generado a partir de modelos admitidos.	No
refusal	cuerda / cadena	Mensaje de denegación generado por el modelo.	No
role	objeto	Rol del autor de un mensaje	No
tool_calls	array		No

AzureChatDataSource

Representación de los datos de configuración para un único origen de datos de chat de OpenAI Azure. Esto lo usará una solicitud de finalizaciones de chat que debe usar Azure extensiones de chat de OpenAI para aumentar el comportamiento de la respuesta. El uso de esta configuración solo es compatible con Azure OpenAI.

Discriminador para AzureChatDataSource

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

Valor del tipo	Schema
azure_search	AzureSearchChatDataSource
azure_cosmos_db	AzureCosmosDBChatDataSource
elasticsearch	ElasticsearchChatDataSource
pinecone	PineconeChatDataSource
mongo_db	MongoDBChatDataSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto		Sí

AzureChatDataSourceAccessTokenAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
access_token	cuerda / cadena		Sí
type	enum	Valores posibles: access_token	Sí

AzureChatDataSourceApiKeyAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
key	cuerda / cadena		Sí
type	enum	Valores posibles: api_key	Sí

AzureChatDataSourceAuthenticationOptions

Discriminador para AzureChatDataSourceAuthenticationOptions

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	AzureChatDataSourceAuthenticationOptionsType		Sí

AzureChatDataSourceAuthenticationOptionsType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	api_key username_and_password connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity

AzureChatDataSourceConnectionStringAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
connection_string	cuerda / cadena		Sí
type	enum	Valores posibles: connection_string	Sí

AzureChatDataSourceDeploymentNameVectorizationSource

Representa un origen de vectorización que realiza llamadas de servicio internas en una implementación de modelo de inserción de OpenAI Azure. A diferencia del origen de vectorización basado en puntos de conexión, un origen de vectorización basado en nombre de implementación debe formar parte del mismo recurso de Azure OpenAI, pero se puede usar incluso en redes privadas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre_de_despliegue	cuerda / cadena	Implementación del modelo de inserción que se va a usar para la vectorización. Esta implementación debe existir dentro del mismo Azure recurso de OpenAI que la implementación del modelo que se usa para las finalizaciones de chat.	Sí
dimensions	entero	Número de dimensiones que se van a solicitar en las incrustaciones. Solo se admite en los modelos "text-embedding-3" y versiones posteriores.	No
type	enum	Identificador de tipo, siempre "deployment_name" para este tipo de origen de vectorización. Valores posibles: deployment_name	Sí

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
encoded_api_key	cuerda / cadena		Sí
type	enum	Valores posibles: encoded_api_key	Sí

AzureChatDataSourceEndpointVectorizationSource

Representa un origen de vectorización que realiza llamadas de servicio público en una implementación de modelo de inserción de OpenAI Azure.

Nombre	Tipo	Description	Obligatorio	Predeterminado
autenticación	objeto		Sí
└" access_token	cuerda / cadena		No
└─ clave	cuerda / cadena		No
└─ Tipo	enum	Valores posibles: access_token	No
dimensions	entero	Número de dimensiones que se van a solicitar en las incrustaciones. Solo se admite en los modelos "text-embedding-3" y versiones posteriores.	No
endpoint	cuerda / cadena	Especifica la dirección URL del punto de conexión de recurso desde la que se deben recuperar las incrustaciones. Debe estar en el formato de: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. El parámetro de consulta api-version no está permitido.	Sí
type	enum	Identificador de tipo, siempre "punto de conexión" para este tipo de origen de vectorización. Valores posibles: endpoint	Sí

AzureChatDataSourceIntegratedVectorizationSource

Representa un origen de vectorización integrado tal como se define en el recurso de búsqueda auxiliar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Identificador de tipo, siempre "integrado" para este tipo de origen de vectorización. Valores posibles: integrated	Sí

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
key	cuerda / cadena		Sí
key_id	cuerda / cadena		Sí
type	enum	Valores posibles: key_and_key_id	Sí

AzureChatDataSourceModelIdVectorizationSource

Representa un origen de vectorización que realiza llamadas de servicio basadas en un identificador de modelo de search service. Actualmente, elasticsearch solo admite este tipo de origen.

Nombre	Tipo	Description	Obligatorio	Predeterminado
model_id	cuerda / cadena	Identificador de compilación del modelo de inserción que se va a usar para la vectorización.	Sí
type	enum	Identificador de tipo, siempre "model_id" para este tipo de origen de vectorización. Valores posibles: model_id	Sí

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

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

AzureChatDataSourceType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	azure_search azure_cosmos_db elasticsearch pinecone mongo_db

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
managed_identity_resource_id	cuerda / cadena		Sí
type	enum	Valores posibles: user_assigned_managed_identity	Sí

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
contraseña	cuerda / cadena		Sí
type	enum	Valores posibles: username_and_password	Sí
nombre de usuario	cuerda / cadena		Sí

AzureChatDataSourceVectorizationSource

Representación de un origen de vectorización de datos que se puede usar como un recurso de inserción con un origen de datos.

Discriminador para AzureChatDataSourceVectorizationSource

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

Valor del tipo	Schema
deployment_name	AzureChatDataSourceDeploymentNameVectorizationSource
integrated	AzureChatDataSourceIntegratedVectorizationSource
model_id	AzureChatDataSourceModelIdVectorizationSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	objeto		Sí

AzureChatDataSourceVectorizationSourceType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	endpoint deployment_name model_id integrated

AzureChatMessageContext

Una propiedad adicional, agregada a los mensajes de respuesta de finalización del chat, generados por el Azure OpenAI service al usar el comportamiento de la extensión. Esto incluye la intención y la información de cita de la característica En los datos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
all_retrieved_documents	objeto	Información de resumen sobre los documentos recuperados por la operación de recuperación de datos.	No
└" chunk_id	cuerda / cadena	Identificador del fragmento de la cita.	No
└─ Contenido	cuerda / cadena	Contenido de la cita.	No
└─ índice_fuente_datos	entero	Índice del origen de datos usado para la recuperación.	No
└─ ruta de archivo	cuerda / cadena	Ruta de archivo para la referencia.	No
└─ razón_del_filtro	enum	Si procede, indica por qué se filtre el documento. Valores posibles: score, rerank	No
└" original_search_score	número	Puntuación de búsqueda original para la recuperación.	No
└" rerank_score	número	Puntuación de reordenamiento para la recuperación.	No
└─ consultas_de_búsqueda	array	Las consultas de búsqueda ejecutadas para recuperar documentos.	No
└─ Título	cuerda / cadena	Título de la cita.	No
└─ URL	cuerda / cadena	Dirección URL de la cita.	No
Citas	array	Las citas producidas por la recuperación de datos.	No
intención	cuerda / cadena	La intención detectada del historial de chat, que se usa para mantener el contexto de la conversación entre interacciones.	No

AzureContentFilterBlocklistResult

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

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

AzureContentFilterCompletionTextSpan

Representación de un intervalo de texto de finalización que usa Azure resultados de filtro de contenido de OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
completion_end_offset	entero	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	Desplazamiento del punto de código UTF32 que comienza el intervalo.	Sí

AzureContentFilterCompletionTextSpanDetectionResult

Nombre	Tipo	Description	Obligatorio	Predeterminado
details	array	Información detallada sobre los intervalos de texto de finalización detectados.	Sí
detected	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
filtered	booleano	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	array	Pares de identificadores de tema individuales y si se detectan.	No
filtered	booleano	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
detected	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	Sí
filtered	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	Sí

AzureContentFilterImagePromptResults

Resultado del filtro de contenido para el contenido de la solicitud de entrada de una operación de generación de imágenes.

Nombre	Tipo	Description	Obligatorio	Predeterminado
custom_blocklists	objeto	Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas.	No
└─ detalles	array	Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado.	No
└* filtrado	booleano	Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado.	No
custom_topics	objeto	Colección de resultados de filtrado true/false para temas personalizados configurados.	No
└─ detalles	array	Pares de identificadores de tema individuales y si se detectan.	No
└* filtrado	booleano	Valor que indica si alguno de los temas detallados produjo una acción de filtrado.	No
jailbreak	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	Sí
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
palabras soeces	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No

AzureContentFilterImageResponseResults

Resultado del filtro de contenido para el contenido de respuesta resultante de una operación de generación de imágenes.

Nombre	Tipo	Description	Obligatorio	Predeterminado
odio	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
Autolesiones	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
sexual	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
violencia	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	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	objeto	Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas.	No
└─ detalles	array	Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado.	No
└* filtrado	booleano	Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado.	No
custom_topics	objeto	Colección de resultados de filtrado true/false para temas personalizados configurados.	No
└─ detalles	array	Pares de identificadores de tema individuales y si se detectan.	No
└* filtrado	booleano	Valor que indica si alguno de los temas detallados produjo una acción de filtrado.	No
error	objeto	Si está presente, detalles sobre un error que impidió que se completara la evaluación del filtrado de contenido.	No
└─ código	entero	Un código distinto legible por la máquina asociado al error.	No
└─ Mensaje	cuerda / cadena	Mensaje legible asociado al error.	No
odio	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
palabras soeces	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
Código de material protegido	objeto	Resultado de detección que describe una coincidencia con el código con licencia u otro material de origen protegido.	No
└─ cita	objeto	Si está disponible, los detalles de la cita que describen la licencia asociada y su ubicación.	No
Dirección URL └	cuerda / cadena	Dirección URL asociada a la licencia.	No
└─ Licencia	cuerda / cadena	Nombre o identificador de la licencia asociada a la detección.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
Texto del material protegido	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
Autolesiones	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
sexual	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		No
violencia	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No

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	objeto	Detalles de la categoría del filtro de contenido para el resultado.	No
└─ listas_de_bloqueo_personalizadas	objeto	Colección de resultados de filtrado true/false para listas de bloqueo personalizadas configuradas.	No
└─ detalles	array	Los pares de identificadores individuales de lista de bloqueos y si han dado lugar a una acción de filtrado.	No
└* filtrado	booleano	Valor que indica si alguna de las listas de bloqueados detalladas produjo una acción de filtrado.	No
└─ temas_personalizados	objeto	Colección de resultados de filtrado true/false para temas personalizados configurados.	No
└─ detalles	array	Pares de identificadores de tema individuales y si se detectan.	No
└* filtrado	booleano	Valor que indica si alguno de los temas detallados produjo una acción de filtrado.	No
└─ Error	objeto	Si está presente, detalles sobre un error que impidió que se completara la evaluación del filtrado de contenido.	No
└─ código	entero	Un código distinto legible por la máquina asociado al error.	No
└─ Mensaje	cuerda / cadena	Mensaje legible asociado al error.	No
└─ odio	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
└─ ataque_indirecto	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
└─ liberar	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
└─ blasfemia	objeto	Elemento de resultado de filtro de contenido etiquetado que indica si el contenido se detectó y si el contenido se filtró.	No
└─ detectado	booleano	Indica si se detectó la categoría de contenido con etiqueta en el contenido.	No
└* filtrado	booleano	Si la detección de contenido dio lugar a una acción de filtrado de contenido.	No
└─ autolesión	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
└— sexual	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
└─ violencia	objeto	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.	No
└* filtrado	booleano	Si la gravedad del contenido dio lugar a una acción de filtrado de contenido.	No
└─ gravedad	enum	La gravedad etiquetada del contenido. Valores posibles: safe, low, medium, high	No
prompt_index	entero	Í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	booleano	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í

AzureCosmosDBChatDataSource

Representa una configuración del origen de datos que usará un recurso de Azure CosmosDB.

Nombre	Tipo	Description	Obligatorio	Predeterminado
parameters	objeto	Información de parámetros para controlar el uso del origen de datos de Azure CosmosDB.	Sí
└─ permitir_resultado_parcial	booleano	Si se configura como verdadero, el sistema permitirá que se utilicen resultados de búsqueda parciales, y la solicitud fallará si todas las consultas parciales fallan. Si no se especifica o se especifica como false, se producirá un error en la solicitud si se produce un error en alguna consulta de búsqueda.	No	Falso
Autenticación └	AzureChatDataSourceConnectionStringAuthenticationOptions		No
├─ container_name	cuerda / cadena		No
└─database_name	cuerda / cadena		No
└─ dependencia_de_incrustación	AzureChatDataSourceVectorizationSource	Representación de un origen de vectorización de datos que se puede usar como un recurso de inserción con un origen de datos.	No
└─ mapeo_de_campos	objeto		No
└─ campos_de_contenido	array		No
└" content_fields_separator	cuerda / cadena		No
└─ campo_de_ruta_de_archivo	cuerda / cadena		No
└─ campo_título	cuerda / cadena		No
└" url_field	cuerda / cadena		No
└─ campos_vectores	array		No
└" in_scope	booleano	Si las consultas deben restringirse al uso de los datos indexados.	No
└─ incluir_contextos	array	Propiedades de contexto de salida que se van a incluir en la respuesta. De forma predeterminada, se solicitarán citas e intenciones.	No	['citas', 'intención']
└" index_name	cuerda / cadena		No
└" max_search_queries	entero	Número máximo de consultas reescritas que se deben enviar al proveedor de búsqueda para un único mensaje de usuario. De forma predeterminada, el sistema realizará una determinación automática.	No
└─ estrictez	entero	La configuración estricta del filtrado de relevancia de búsqueda. Una mayor precisión aumentará la precisión, pero la menor recuperación de la respuesta.	No
└" top_n_documents	entero	Número configurado de documentos que se van a presentar en la consulta.	No
type	enum	Identificador de tipo discriminado, que siempre es "azure_cosmos_db". Valores posibles: azure_cosmos_db	Sí

AzureCreateChatCompletionRequest

Modelo de solicitud extendida para finalizaciones de chat en el Azure OpenAI service. Esto agrega la capacidad de proporcionar fuentes de datos para la función En Tus Datos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
audio	objeto	Parámetros para la salida de audio. Obligatorio cuando se solicita la salida de audio con modalities: ["audio"].	No
└─ Formato	enum	Especifica el formato de audio de salida. Debe ser uno de los elementos wav, mp3, flac, opuso pcm16. Valores posibles: wav, aac, mp3, flac, , opus, pcm16	No
└─ voz	objeto		No
data_sources	array	Los orígenes de datos que se van a usar para la característica En sus datos, exclusivos de Azure OpenAI.	No
frequency_penalty	número	Número entre 2.0 y 2.0. Los valores positivos penalizan los nuevos tokens en función de su frecuencia existente en el texto hasta el momento, disminuyendo la probabilidad del modelo de repetir la misma línea textualmente.	No	0
function_call	enum	Especificar una función determinada a través de {"name": "my_function"} obliga al modelo a llamar a esa función. Valores posibles: none, auto	No
functions	array	En desuso en favor de tools. Una lista de funciones para las que el modelo puede generar entradas JSON.	No
logit_bias	objeto	Modifica la probabilidad de que los tokens especificados aparezcan en la finalización. Acepta un objeto JSON que asigna tokens (especificados por su Id. de token en el tokenizador) 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á según el modelo, pero los valores entre -1 y 1 deberían disminuir o aumentar la probabilidad de selección; valores como -100 o 100 deberían dar lugar a una prohibición o selección exclusiva del token correspondiente.	No	Ninguno
logprobs	booleano	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	Falso
max_completion_tokens	entero	Límite superior del número de tokens que se pueden generar para una finalización, incluidos los tokens de razonamiento y los tokens de salida visibles.	No
max_tokens	entero	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 no es compatible con los modelos de la serie o1.	No
messages	array	Una lista de mensajes que componen la conversación hasta ahora. Según el modelo que use, se admiten diferentes tipos de mensajes (modalidades), como texto, imágenes y audio.	Sí
metadata	objeto	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.	No
modalidades	objeto	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 modelo gpt-4o-audio-preview también se puede usar para generar audio. Para solicitar que este modelo genere respuestas de texto y audio, puede usar: ["text", "audio"]	No
modelo	cuerda / cadena	Identificador de implementación del modelo que se va a usar para la solicitud de finalización del chat.	Sí
n	entero	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 como 1 para minimizar los costos.	No	1
parallel_tool_calls	objeto	Indica si se debe habilitar la llamada a funciones paralelas durante el uso de la herramienta.	No
prediction	objeto	Representación base de la salida predicha de un modelo.	No
└─ Tipo	OpenAI.ChatOutputPredictionType		No
presence_penalty	número	Número entre 2.0 y 2.0. Los valores positivos penalizan los nuevos tokens en función de su aparición en el texto hasta el momento, aumentando la probabilidad de que el modelo hable de nuevos temas.	No	0
esfuerzo de razonamiento	objeto	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
formato_de_respuesta	objeto		No
└─ Tipo	enum	Valores posibles: text, json_object, json_schema	No
seed	entero	Esta característica está en versión beta. Si se especifica, el sistema realizará un mejor esfuerzo para muestrear de manera determinista, de modo que las solicitudes repetidas con un mismo seed y parámetros deben devolver el mismo resultado. No se garantiza el determinismo y debe hacer referencia al parámetro de respuesta system_fingerprint para supervisar los cambios en el back-end.	No
stop	objeto	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.	No
store	booleano	Si se va a almacenar o no la salida de esta solicitud de finalización del chat para su uso en los productos de destilación de modelos ovales.	No	Falso
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor.	No	Falso
stream_options	objeto	Opciones para la respuesta de streaming. Establezca este valor solo cuando defina stream: true.	No
└─ incluir_uso	booleano	Si se establece, se transmitirá un fragmento adicional delante del mensaje data: [DONE]. El campo usage de este fragmento muestra las estadísticas de uso de tokens de toda la solicitud y el campo choices siempre será una matriz vacía. El resto de fragmentos también incluirá un campo usage, pero con un valor NULL. NOTA: Si se interrumpe la secuencia, es posible que no reciba el fragmento de uso final que contiene el uso total del token para la solicitud.	No
temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No	1
tool_choice	OpenAI.ChatCompletionToolChoiceOption	Controla la herramienta (si existe) a la que llama el modelo. 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"}} obliga 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
herramientas	array	Una lista de herramientas a las que puede llamar el modelo. Actualmente, solo se admiten funciones como una herramienta. Úselo para proporcionar una lista de funciones para las que el modelo puede generar entradas JSON. Se admite un máximo de 128 funciones.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No	1
user	cuerda / cadena	Identificador único que representa al usuario final, lo 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 for Cloud.	No

AzureCreateChatCompletionResponse

Modelo extendido de respuesta de finalización de chat de nivel superior para el Azure OpenAI service. Este modelo agrega anotaciones de filtro de contenido de IA responsable para la entrada del mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
opciones	array		Sí
creado	entero	Marca de tiempo de Unix (en segundos) de cuando se creó la finalización de chat.	Sí
id	cuerda / cadena	Identificador único para la finalización del chat.	Sí
modelo	cuerda / cadena	Modelo usado para la finalización de chat.	Sí
objeto	enum	Tipo de objeto, que siempre es chat.completion. Valores posibles: chat.completion	Sí
prompt_filter_results	array	Las anotaciones de filtro de contenido de IA responsable asociadas a entradas de solicitud en finalizaciones de chat.	No
system_fingerprint	cuerda / cadena	Esta huella digital representa la configuración de back-end con la que se ejecuta el modelo. Se puede usar junto con el parámetro de solicitud seed para comprender cuándo se han realizado cambios de back-end que podrían afectar al determinismo.	No
usage	OpenAI.CompletionUsage	Estadísticas de uso de la solicitud de finalización.	No

AzureCreateChatCompletionStreamResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
opciones	array	Una lista de opciones de finalización de chat. Puede contener más de un elemento si n es mayor que 1. También puede estar vacío para el último fragmento si establece stream_options: {"include_usage": true}.	Sí
content_filter_results	AzureContentFilterResultForChoice	Resultado del filtro de contenido para un único elemento de respuesta generado por un sistema de IA generativo.	No
creado	entero	Marca de tiempo de Unix (en segundos) de cuando se creó la finalización de chat. Cada fragmento tiene la misma marca de tiempo.	Sí
delta	AzureChatCompletionStreamResponseDelta	Modelo de respuesta extendida para un mensaje de respuesta de chat en streaming en el Azure OpenAI service. Este modelo añade compatibilidad con el contexto del mensaje de chat, utilizado por la función On Your Data para la intención, las citas y otra información relacionada con la generación aumentada por recuperación realizada.	No
id	cuerda / cadena	Identificador único para la finalización del chat. Cada fragmento tiene el mismo id.	Sí
modelo	cuerda / cadena	Modelo para generar la finalización.	Sí
objeto	enum	Tipo de objeto, que siempre es chat.completion.chunk. Valores posibles: chat.completion.chunk	Sí
system_fingerprint	cuerda / cadena	Esta huella digital representa la configuración de back-end con la que se ejecuta el modelo. Se puede usar junto con el parámetro de solicitud seed para comprender cuándo se han realizado cambios de back-end que podrían afectar al determinismo.	No
usage	objeto	Estadísticas de uso de la solicitud de finalización.	No
└─ tokens_de_finalización	entero	Número de tokens en la finalización generada.	No	0
└─ detalles_de_tokens_de_completitud	objeto	Desglose de los tokens que se usan en una finalización.	No
└─ tokens_de_prediccion_aceptados	entero	Cuando se usan salidas predichas, el número de tokens de la predicción que apareció en la finalización.	No	0
└" audio_tokens	entero	Tokens de entrada de audio generados por el modelo.	No	0
─ reasoning_tokens	entero	Tokens generados por el modelo para razonamiento.	No	0
└─ tokens_de_prediccion_rechazados	entero	Cuando se usan salidas predichas, el número de tokens de la predicción que no aparecen en la finalización. Sin embargo, al igual que los tokens de razonamiento, estos tokens todavía se cuentan en los tokens de finalización total con fines de facturación, salida y límites de ventana de contexto.	No	0
└" prompt_tokens	entero	Número de tokens en el símbolo del sistema.	No	0
``` └─ "prompt_tokens_details" ```	objeto	Desglose de los tokens usados en la solicitud.	No
└" audio_tokens	entero	Tokens de entrada de audio presentes en el símbolo del sistema.	No	0
└─ tokens en caché	entero	Tokens almacenados en caché presentes en el mensaje.	No	0
└" total_tokens	entero	Número total de tokens usados en la solicitud (solicitud + finalización).	No	0

AzureCreateEmbeddingRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
dimensions	entero	Número de dimensiones que deben tener las incrustaciones de salida resultantes. Solo se admite en modelos text-embedding-3 y versiones posteriores.	No
encoding_format	enum	Formato en el que se devuelven las incrustaciones. Puede ser float o base64. Valores posibles: float, base64	No
entrada	cadena o matriz		Sí
modelo	cuerda / cadena	Modelo que se va a usar para la solicitud de inserción.	Sí
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

AzureCreateFileRequestMultiPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
expires_after	objeto		Sí
└─ delimitador	AzureFileExpiryAnchor		No
└─ segundos	entero		No
archivo	cuerda / cadena		Sí
finalidad	enum	El propósito previsto del archivo cargado. Uno de los siguientes: assistants: se usa en la API de asistentes batch: se usa en la API Batch fine-tune: se usa para ajuste fino: evals: se usa para conjuntos de datos de evaluación. Valores posibles: assistants, batch, fine-tune, evals	Sí

AzureCreateImageEditRequestMultiPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Permite establecer transparencia para el fondo de las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de transparent, opaque o auto (valor predeterminado). Cuando auto se usa, el modelo determinará automáticamente el mejor fondo para la imagen. Si transparent es, el formato de salida debe admitir la transparencia, por lo que debe establecerse en png (valor predeterminado) o webp. Valores posibles: transparent, opaque, auto	No
imagen	cadena o matriz		Sí
máscara	cuerda / cadena		No
modelo	cuerda / cadena	Implementación del modelo que se va a usar para la operación de edición de imágenes.	Sí
n	entero	Número de imágenes que se van a generar. Debe estar entre 1 y 10.	No	1
compresión_de_salida	entero	Nivel de compresión (0-100%) para las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1 con los formatos de salida webp o jpeg, y el valor predeterminado es 100.	No	100
formato_de_salida	enum	Formato en el que se devuelven las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de los siguientes valores: png, jpeg o webp. El valor predeterminado es png. Valores posibles: png, jpeg, webp	No
inmediato	cuerda / cadena	Descripción de texto de las imágenes deseadas. La longitud máxima es de 1000 caracteres para dall-e-2, y 32000 caracteres para gpt-image-1los modelos de serie .	Sí
calidad	enum	Calidad de la imagen que se generará. high, medium y low solo se admiten para los modelos de la serie gpt-image-1. dall-e-2 solo soporta la calidad standard. Tiene como valor predeterminado auto. Valores posibles: standard, low, medium, , high, auto	No
formato_de_respuesta	enum	Formato en el que se devuelven las imágenes generadas. Debe ser uno de url o b64_json. Las direcciones URL solo son válidas durante 60 minutos después de que se haya generado la imagen. Este parámetro solo se admite para dall-e-2, ya gpt-image-1que los modelos de serie siempre devolverán imágenes codificadas en base64. Valores posibles: url, b64_json	No
tamaño	enum	Tamaño de las imágenes generadas. Debe ser uno de 1024x1024, 1536x1024 (horizontal), 1024x1536 (vertical) o auto (valor predeterminado) para los modelos de la serie gpt-image-1, y uno de 256x256, 512x512 o 1024x1024 para dall-e-2. Valores posibles: 256x256, 512x512, 1024x1024, 1536x1024, , 1024x1536, auto	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

AzureCreateImageRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Permite establecer transparencia para el fondo de las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de transparent, opaque o auto (valor predeterminado). Cuando auto se usa, el modelo determinará automáticamente el mejor fondo para la imagen. Si transparent es, el formato de salida debe admitir la transparencia, por lo que debe establecerse en png (valor predeterminado) o webp. Valores posibles: transparent, opaque, auto	No
modelo	cuerda / cadena	Implementación del modelo que se va a usar para la generación de imágenes.	Sí
moderation	enum	Controle el nivel de moderación de contenido para las imágenes generadas por modelos de la serie gpt-image-1. Debe ser low para un filtrado menos restrictivo o auto (valor predeterminado). Valores posibles: low, auto	No
n	entero	Número de imágenes que se van a generar. Debe estar entre 1 y 10. Para dall-e-3, solo n=1 se admite.	No	1
compresión_de_salida	entero	Nivel de compresión (0-100%) para las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1 con los formatos de salida webp o jpeg, y el valor predeterminado es 100.	No	100
formato_de_salida	enum	Formato en el que se devuelven las imágenes generadas. Este parámetro solo se admite para modelos de la serie gpt-image-1. Debe ser uno de los siguientes valores: png, jpeg o webp. Valores posibles: png, jpeg, webp	No
inmediato	cuerda / cadena	Descripción de texto de las imágenes deseadas. La longitud máxima es de 32000 caracteres para gpt-image-1 de la serie, 1000 caracteres para dall-e-2 y 4000 caracteres para dall-e-3.	Sí
calidad	enum	Calidad de la imagen que se generará. - auto (valor predeterminado) seleccionará automáticamente la mejor calidad para el modelo especificado. - high, medium y low son compatibles para los modelos de la serie gpt-image-1. - hd y standard son compatibles con dall-e-3. - standard es la única opción para dall-e-2. Valores posibles: standard, hd, low, medium, , high, auto	No
formato_de_respuesta	enum	Formato en el que se devuelven las imágenes generadas con dall-e-2 y dall-e-3 . Debe ser uno de url o b64_json. Las direcciones URL solo son válidas durante 60 minutos después de que se haya generado la imagen. Este parámetro no es compatible con los modelos de la serie gpt-image-1, los cuales siempre devolverán imágenes codificadas en base64. Valores posibles: url, b64_json	No
tamaño	enum	Tamaño de las imágenes generadas. Debe ser uno de 1024x1024, 1536x1024 (horizontal), 1024x1536 (vertical) o auto (valor predeterminado) para gpt-image-1, modelos de la serie, uno de 256x256, 512x512, o 1024x1024 para dall-e-2, y uno de 1024x1024, 1792x1024, o 1024x1792 para dall-e-3. Valores posibles: auto, 1024x1024, 1536x1024, 1024x1536, 256x256, 512x512, , , 1792x10241024x1792	No
style	enum	Estilo de las imágenes generadas. Este parámetro solamente se admite en dall-e-3. Debe ser uno de vivid o natural. Vívido hace que el modelo se inclina hacia la generación de imágenes hiper-reales y dramáticas. Natural permite que el modelo produzca imágenes más naturales, menos hiperrealistas. Valores posibles: vivid, natural	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

AzureCreateResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
incluir	array	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Los valores admitidos actualmente son: - code_interpreter_call.outputs: incluye las salidas de la ejecución de código de Python en los elementos de llamada de la herramienta de intérprete de código. - computer_call_output.output.image_url: incluya direcciones URL de imagen desde la salida de la llamada del equipo. - file_search_call.results: incluya los resultados de búsqueda de la llamada a la herramienta de búsqueda de archivos. - message.input_image.image_url: incluya las URL de las imágenes del mensaje de entrada. - message.output_text.logprobs: incluya logprobs con mensajes de asistente. - reasoning.encrypted_content: incluye una versión cifrada de tokens de razonamiento en las salidas del elemento de razonamiento. Esto permite que los elementos de razonamiento se utilicen en conversaciones multiturno cuando se utiliza la API de Respuestas de manera sin estado (como cuando el store parámetro está configurado en false, o cuando una organización está inscrita en el programa de cero retención de datos).	No
entrada	cadena o matriz		No
instructions	cuerda / cadena	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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.	No
modelo	cuerda / cadena	Implementación del modelo que se va a usar para la creación de esta respuesta.	Sí
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
inmediato	objeto	Referencia a una plantilla de solicitud y sus variables.	No
└─ id.	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	No
Variables └	OpenAI.ResponsePromptVariables	Asignación opcional de valores para sustituir por variables en la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.	No
└─ versión	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
└─ generar_resumen	enum	En desuso: use summary en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
store	booleano	Si se va a almacenar la respuesta del modelo generada para su recuperación posterior a través de la API.	No	Cierto
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor.	No	Falso
temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No	1
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	objeto	Controla la herramienta (si existe) a la que llama el modelo. 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.	No
└─ Tipo	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo, como la búsqueda de archivos. - Llamadas a funciones (herramientas personalizadas): funciones definidas por usted, lo que permite que el modelo llame a su propio código.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No	1
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No

AzureCreateSpeechRequestMultiPart

Representación de las opciones de solicitud que controlan el comportamiento de una operación de texto a voz.

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	cuerda / cadena	Texto para el que se va a generar audio. La longitud máxima es de 4096 caracteres.	Sí
instructions	cuerda / cadena	Controle la voz del audio generado con instrucciones adicionales. No funciona con tts-1 o tts-1-hd.	No
modelo	cuerda / cadena	Modelo que se va a usar para esta solicitud de texto a voz.	Sí
formato_de_respuesta	objeto	Formatos de salida de audio admitidos para texto a voz.	No
speed	número	Velocidad del habla para el audio generado. Los valores son válidos en el intervalo de 0,25 a 4,0, con 1,0 los valores predeterminados y superiores correspondientes a una voz más rápida.	No	1
stream_format	enum	Formato en el que se va a transmitir el audio. Los formatos admitidos son sse y audio. sse no se admite para tts-1 o tts-1-hd. Valores posibles: sse, audio	No
voice	objeto		Sí

AzureCreateTranscriptionRequestMultiPart

La información de configuración de una solicitud de transcripción de audio.

Nombre	Tipo	Description	Obligatorio	Predeterminado
chunking_strategy	objeto		No
" prefix_padding_ms	entero	Cantidad de audio que se va a incluir antes de que el VAD detecte voz (en milisegundos).	No	300
└─ silencio_duración_ms	entero	Duración del silencio para detectar la detención de voz (en milisegundos). Con valores más cortos, el modelo responderá más rápidamente, pero puede saltar en pausas cortas del usuario.	No	200
└─ umbral	número	Umbral de sensibilidad (de 0,0 a 1,0) para la detección de actividad de voz. Un umbral superior requerirá audio más alto para activar el modelo y, por tanto, podría funcionar mejor en entornos ruidosos.	No	0,5
└─ Tipo	enum	Debe establecerse en server_vad para habilitar la fragmentación manual mediante VAD del lado servidor. Valores posibles: server_vad	No
archivo	cuerda / cadena		Sí
filename	cuerda / cadena	Nombre de archivo opcional o identificador descriptivo al que se va a asociar con los datos de audio.	No
include[]	array	Información adicional que se va a incluir en la respuesta de transcripción. logprobs devolverá las probabilidades logarítmicas de los tokens en la respuesta para comprender la confianza del modelo en la transcripción. logprobs solo funciona con response_format establecido en json y solo con los modelos gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribe y gpt-4o-mini-transcribe-2025-12-15.	No
lenguaje	cuerda / cadena	El idioma del audio de entrada. Proporcionar el idioma de entrada en formato ISO-639-1 (por ejemplo, en) mejorará la precisión y la latencia.	No
modelo	cuerda / cadena	Modelo que se va a usar para esta solicitud de transcripción.	No
inmediato	cuerda / cadena	Texto opcional para guiar el estilo del modelo o continuar con un segmento de audio anterior. El mensaje debe coincidir con el idioma del audio.	No
formato_de_respuesta	objeto		No
flujo	booleano	Si se establece en true, los datos de respuesta del modelo se transmitirán al cliente a medida que se generan mediante eventos enviados por el servidor. Nota: El streaming no se admite para el whisper-1 modelo y se omitirá.	No	Falso
temperatura	número	Temperatura de muestreo, entre 0 y 1. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Si se establece en 0, el modelo usará probabilidad logarítmica para aumentar la temperatura de forma automática hasta alcanzar ciertos umbrales.	No	0
timestamp_granularities[]	array	Granularidades de marca de tiempo que se van a rellenar para esta transcripción. response_format debe establecerse en verbose_json para usar granularidades de marca de tiempo. Se admiten una o ambas opciones: word o segment. Nota: No hay ninguna latencia adicional para las marcas de tiempo de segmento, pero la generación de marcas de tiempo de palabra incurre en una latencia adicional.	No	['segment']

AzureCreateTranslationRequestMultiPart

La información de configuración de una solicitud de transcripción de audio.

Nombre	Tipo	Description	Obligatorio	Predeterminado
archivo	cuerda / cadena		Sí
filename	cuerda / cadena	Nombre de archivo opcional o identificador descriptivo al que se va a asociar con los datos de audio	No
modelo	cuerda / cadena	Modelo que se va a usar para esta solicitud de traducción.	No
inmediato	cuerda / cadena	Texto opcional para guiar el estilo del modelo o continuar con un segmento de audio anterior. La indicación debería ser en inglés.	No
formato_de_respuesta	objeto		No
temperatura	número	Temperatura de muestreo, entre 0 y 1. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Si se establece en 0, el modelo usará probabilidad logarítmica para aumentar la temperatura de forma automática hasta alcanzar ciertos umbrales.	No	0

AzureErrorResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	objeto	Detalles del error.	No
└─ código	cuerda / cadena	Identificador distinto generado por la máquina para el error.	No
└" inner_error			No
└─ Mensaje	cuerda / cadena	Mensaje legible asociado al error.	No
└— param	cuerda / cadena	Si procede, el parámetro de entrada de solicitud asociado al error	No
└─ Tipo	enum	El tipo de objeto, siempre 'error'. Valores posibles: error	No

AzureEvalAPICompletionsSamplingParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
parallel_tool_calls	booleano		No
formato_de_respuesta	OpenAI.ResponseTextFormatConfiguration		No
herramientas	array		No

AzureEvalAPIModelSamplingParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
max_tokens	entero	Número máximo de tokens en la salida generada.	No
esfuerzo de razonamiento	enum	Controla el nivel de esfuerzo de razonamiento aplicado durante la generación. Valores posibles: low, medium, high	No
seed	entero	Valor de inicialización para inicializar la aleatoriedad durante el muestreo.	No
temperatura	número	Una temperatura mayor aumenta la aleatoriedad en las salidas.	No
top_p	número	Alternativa a la temperatura para el muestreo del núcleo; 1.0 incluye todos los tokens.	No

AzureEvalAPIResponseSamplingParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
parallel_tool_calls	booleano		No
formato_de_respuesta	OpenAI.ResponseTextFormatConfiguration		No
herramientas	array		No

AzureFileExpiryAnchor

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	created_at

AzureFineTuneReinforcementMethod

Nombre	Tipo	Description	Obligatorio	Predeterminado
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	No
└─ evaluadores	objeto		No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
└─ Tipo	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	No
hiperparámetros	OpenAI.FineTuneReinforcementHyperparameters	Los hiperparámetros usados para el trabajo de ajuste preciso de refuerzo.	No
formato_de_respuesta	objeto		No
└" json_schema	objeto	Esquema JSON para el formato de respuesta	No
└─ Tipo	enum	Tipo de formato de respuesta. Valores posibles: json_schema	No

AzureImage

Nombre	Tipo	Description	Obligatorio	Predeterminado
b64_json	cuerda / cadena	JSON codificado en base64 de la imagen generada. Valor predeterminado para los modelos de la serie gpt-image-1, y solo está presente si response_format está establecido en b64_json para dall-e-2 y dall-e-3.	No
content_filter_results	AzureContentFilterImageResponseResults	Resultado del filtro de contenido para el contenido de respuesta resultante de una operación de generación de imágenes.	Sí
prompt_filter_results	AzureContentFilterImagePromptResults	Resultado del filtro de contenido para el contenido de la solicitud de entrada de una operación de generación de imágenes.	Sí
mensaje_revisado	cuerda / cadena	Solo para dall-e-3, la indicación revisada que se usó para generar la imagen.	No
URL	cuerda / cadena	Cuando se usa dall-e-2 o dall-e-3, la dirección URL de la imagen generada si response_format se establece en url (valor predeterminado). No se admite para modelos de la serie gpt-image-1.	No

AzureImagesResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Parámetro en segundo plano usado para la generación de imágenes. transparent o opaque. Valores posibles: transparent, opaque	No
creado	entero	Marca de tiempo de Unix (en segundos) de cuando se creó la imagen.	Sí
datos	array		No
formato_de_salida	enum	Formato de salida de la generación de imágenes. png, webp o jpeg. Valores posibles: png, webp, jpeg	No
calidad	enum	Calidad de la imagen generada. low, medium o high. Valores posibles: low, medium, high	No
tamaño	enum	Tamaño de la imagen generada. 1024x1024, 1024x1536 o 1536x1024. Valores posibles: 1024x1024, 1024x1536, 1536x1024	No
usage	objeto	Solo para los modelos de la serie gpt-image-1, información sobre el uso de tokens para la generación de imágenes.	No
└─ input_tokens	entero	Número de tokens (imágenes y texto) en el símbolo del sistema de entrada.	No
└─ detalles_de_tokens_de_entrada	objeto	La información detallada de los tokens de entrada para la generación de imágenes.	No
└" image_tokens	entero	Número de tokens de imagen en el símbolo del sistema de entrada.	No
└" text_tokens	entero	Número de tokens de texto en el símbolo del sistema de entrada.	No
└─ output_tokens	entero	Número de tokens de imagen en la imagen de salida.	No
└" total_tokens	entero	Número total de tokens (imágenes y texto) usados para la generación de imágenes.	No

AzureListFilesResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
first_id	cuerda / cadena		Sí
has_more	booleano		Sí
last_id	cuerda / cadena		Sí
objeto	enum	Valores posibles: list	Sí

AzureOpenAIFile

Nombre	Tipo	Description	Obligatorio	Predeterminado
bytes	entero	Tamaño del archivo, en bytes.	Sí
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el archivo.	Sí
expires_at	entero	Marca de tiempo de Unix (en segundos) para cuando expire el archivo.	No
filename	cuerda / cadena	El nombre del archivo.	Sí
id	cuerda / cadena	Identificador de archivo, al que se puede hacer referencia en los puntos de conexión de API.	Sí
objeto	enum	Tipo de objeto, que siempre es file. Valores posibles: file	Sí
finalidad	enum	Propósito previsto del archivo. Los valores admitidos son assistants, assistants_output, batch, batch_output, fine-tune y fine-tune-results. Valores posibles: assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, evals	Sí
estado	enum	Valores posibles: uploaded, pending, running, processed, error, deleting, deleted	Sí
detalles_del_estado	cuerda / cadena	Deprecated. Para obtener más información sobre por qué se produjo un error en la validación de un archivo de entrenamiento de ajuste preciso, consulte el campo error en fine_tuning.job.	No

AzureOpenAIVideoGenerationErrorResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Identificador distinto generado por la máquina para el error.	No
inner_error	objeto	Si procede, un error anterior que causó este error.	No
└─ código	enum	Código asociado al error interno. Valores posibles: ResponsibleAIPolicyViolation	No
└─ detalles_del_error		Detalles del resultado del filtro de contenido asociados al error interno.	No
└" revised_prompt	cuerda / cadena	Si procede, la solicitud modificada usada para la generación.	No
Mensaje	cuerda / cadena	Mensaje legible asociado al error.	No
param	cuerda / cadena	Si procede, el parámetro de entrada de solicitud asociado al error	No
type	cuerda / cadena	Si procede, el número de línea de entrada asociado al error.	No

AzureResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	objeto	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ código	OpenAI.ResponseErrorCode	Código de error de la respuesta.	No
└─ Mensaje	cuerda / cadena	Una descripción legible del error.	No
id	cuerda / cadena	Identificador único de esta respuesta.	Sí
incomplete_details	objeto	Detalles sobre por qué la respuesta está incompleta.	Sí
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
instructions	cadena o matriz		Sí
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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.	Sí
modelo	cuerda / cadena	Modelo que se usa para generar esta respuesta.	Sí
objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	Sí
output	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	Sí
output_text	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
inmediato	objeto	Referencia a una plantilla de solicitud y sus variables.	No
└─ id.	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	No
Variables └	OpenAI.ResponsePromptVariables	Asignación opcional de valores para sustituir por variables en la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.	No
└─ versión	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
└─ generar_resumen	enum	En desuso: use summary en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	Sí
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	objeto	Controla la herramienta (si existe) a la que llama el modelo. 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.	No
└─ Tipo	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	Sí
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
usage	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	Sí

AzureSearchChatDataSource

Representa una configuración del origen de datos que usará un recurso de Azure Search.

Nombre	Tipo	Description	Obligatorio	Predeterminado
parameters	objeto	Información de parámetros para controlar el uso del origen de datos de Azure Search.	Sí
└─ permitir_resultado_parcial	booleano	Si se configura como verdadero, el sistema permitirá que se utilicen resultados de búsqueda parciales, y la solicitud fallará si todas las consultas parciales fallan. Si no se especifica o se especifica como false, se producirá un error en la solicitud si se produce un error en alguna consulta de búsqueda.	No	Falso
Autenticación └	objeto		No
└" access_token	cuerda / cadena		No
└─ clave	cuerda / cadena		No
└ managed_identity_resource_id	cuerda / cadena		No
└─ Tipo	enum	Valores posibles: access_token	No
└─ dependencia_de_incrustación	objeto	Representa un origen de vectorización que realiza llamadas de servicio público en una implementación de modelo de inserción de OpenAI Azure.	No
Autenticación └	AzureChatDataSourceApiKeyAuthenticationOptions o AzureChatDataSourceAccessTokenAuthenticationOptions	Mecanismo de autenticación que se utilizará con la fuente de vectorización basada en un endpoint. La autenticación de puntos de conexión admite la clave de API y los mecanismos de token de access.	No
└" deployment_name	cuerda / cadena	Implementación del modelo de inserción que se va a usar para la vectorización. Esta implementación debe existir dentro del mismo Azure recurso de OpenAI que la implementación del modelo que se usa para las finalizaciones de chat.	No
└─ dimensiones	entero	Número de dimensiones que se van a solicitar en las incrustaciones. Solo se admite en los modelos "text-embedding-3" y versiones posteriores.	No
└─ punto de conexión	cuerda / cadena	Especifica la dirección URL del punto de conexión de recurso desde la que se deben recuperar las incrustaciones. Debe estar en el formato de: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. El parámetro de consulta api-version no está permitido.	No
└─ Tipo	enum	Identificador de tipo, siempre "integrado" para este tipo de origen de vectorización. Valores posibles: integrated	No
└─ punto de conexión	cuerda / cadena	Ruta de acceso del punto de conexión absoluto para el recurso de búsqueda de Azure que se va a usar.	No
└─ mapeo_de_campos	objeto	Asignaciones de campos que se van a usar con el recurso Azure Search.	No
└─ campos_de_contenido	array	Nombre de los campos de índice que se deben tratar como contenido.	No
└" content_fields_separator	cuerda / cadena	Patrón separador que deben usar los campos de contenido.	No
└─ campo_de_ruta_de_archivo	cuerda / cadena	Nombre del campo de índice que se va a usar como ruta de acceso de archivo.	No
└─ campos_vectoriales_de_imagen	array	Los nombres de los campos que representan datos vectoriales.	No
└─ campo_título	cuerda / cadena	Nombre del campo de índice que se va a usar como título.	No
└" url_field	cuerda / cadena	Nombre del campo de índice que se va a usar como dirección URL.	No
└─ campos_vectores	array	Los nombres de los campos que representan datos vectoriales.	No
└─ filtro	cuerda / cadena	Filtro que se va a aplicar a la búsqueda.	No
└" in_scope	booleano	Si las consultas deben restringirse al uso de los datos indexados.	No
└─ incluir_contextos	array	Propiedades de contexto de salida que se van a incluir en la respuesta. De forma predeterminada, se solicitarán citas e intenciones.	No	['citas', 'intención']
└" index_name	cuerda / cadena	Nombre del índice que se va a usar, tal como se especifica en el recurso Azure Search.	No
└" max_search_queries	entero	Número máximo de consultas reescritas que se deben enviar al proveedor de búsqueda para un único mensaje de usuario. De forma predeterminada, el sistema realizará una determinación automática.	No
└" query_type	enum	Tipo de consulta para el recurso de búsqueda de Azure que se va a usar. Valores posibles: simple, semantic, vector, , vector_simple_hybrid, vector_semantic_hybrid	No
└─ configuración_semántica	cuerda / cadena	Configuración semántica adicional para la consulta.	No
└─ estrictez	entero	La configuración estricta del filtrado de relevancia de búsqueda. Una mayor precisión aumentará la precisión, pero la menor recuperación de la respuesta.	No
└" top_n_documents	entero	Número configurado de documentos que se van a presentar en la consulta.	No
type	enum	El identificador de tipo discriminado, que siempre es "azure_search". Valores posibles: azure_search	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 for Cloud.

Nombre	Tipo	Description	Obligatorio	Predeterminado
application_name	cuerda / cadena	Nombre de la aplicación. La información personal confidencial no debe incluirse en este campo.	No
end_user_id	cuerda / cadena	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	cuerda / cadena	El identificador de inquilino Microsoft 365 al que pertenece el usuario final. Es necesario cuando la aplicación de IA generativa tiene una arquitectura multitenencia.	No
source_ip	cuerda / cadena	Captura la dirección IP del cliente original.	No

ChatCompletionMessageToolCallsItem

Llamadas a herramientas generadas por el modelo, como las llamadas a funciones.

Matriz de: OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
altura	entero	Alto del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí
modelo	cuerda / cadena	Nombre de la implementación que se va a usar para esta solicitud.	Sí
n_seconds	entero	Duración del trabajo de generación de vídeo. Debe estar entre 1 y 20 segundos.	No	5
n_variants	entero	Número de vídeos que se van a crear como variantes para este trabajo. Debe estar entre 1 y 5. Las dimensiones más pequeñas permiten más variantes.	No	1
inmediato	cuerda / cadena	Solicitud de este trabajo de generación de vídeo.	Sí
Ancho	entero	Ancho del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí

CreateVideoGenerationWithMediaRequestMultiPart

Propiedades de una solicitud de trabajo de generación de vídeo con archivos multimedia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
files	array		Sí
altura	entero	Alto del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí
inpaint_items	array	Elementos opcionales de inpainting para este trabajo de generación de vídeo.	No
modelo	cuerda / cadena	Nombre de la implementación que se va a usar para esta solicitud.	Sí
n_seconds	entero	Duración del trabajo de generación de vídeo. Debe estar entre 1 y 20 segundos.	No	5
n_variants	entero	Número de vídeos que se van a crear como variantes para este trabajo. Debe estar entre 1 y 5. Las dimensiones más pequeñas permiten más variantes.	No	1
inmediato	cuerda / cadena	Solicitud de este trabajo de generación de vídeo.	Sí
Ancho	entero	Ancho del vídeo. Se admiten las siguientes dimensiones: 480x480, 854x480, 720x720, 1280x720, 1080x1080 y 1920x1080 en orientación horizontal y vertical.	Sí

CropBounds

Límites de recorte para un elemento de inpainting. Especifica el área del elemento multimedia que se debe usar para inpainting.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bottom_fraction	número	Límite inferior del cuadro de recorte especificado como fracción del alto del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del alto del elemento multimedia original.	No	1
left_fraction	número	Límite izquierdo del cuadro de recorte especificado como fracción del ancho del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del ancho del elemento multimedia original.	No	0
right_fraction	número	Límite derecho del cuadro de recorte especificado como fracción del ancho del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del ancho del elemento multimedia original.	No	1
top_fraction	número	Límite superior del cuadro de recorte especificado como fracción del alto del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del alto del elemento multimedia original.	No	0

ElasticsearchChatDataSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
parameters	objeto	Información de parámetros para controlar el uso del origen de datos de Elasticsearch.	Sí
└─ permitir_resultado_parcial	booleano	Si se configura como verdadero, el sistema permitirá que se utilicen resultados de búsqueda parciales, y la solicitud fallará si todas las consultas parciales fallan. Si no se especifica o se especifica como false, se producirá un error en la solicitud si se produce un error en alguna consulta de búsqueda.	No	Falso
Autenticación └	objeto		No
" encoded_api_key	cuerda / cadena		No
└─ clave	cuerda / cadena		No
└" key_id	cuerda / cadena		No
└─ Tipo	enum	Valores posibles: encoded_api_key	No
└─ dependencia_de_incrustación	AzureChatDataSourceVectorizationSource	Representación de un origen de vectorización de datos que se puede usar como un recurso de inserción con un origen de datos.	No
└─ punto de conexión	cuerda / cadena		No
└─ mapeo_de_campos	objeto		No
└─ campos_de_contenido	array		No
└" content_fields_separator	cuerda / cadena		No
└─ campo_de_ruta_de_archivo	cuerda / cadena		No
└─ campo_título	cuerda / cadena		No
└" url_field	cuerda / cadena		No
└─ campos_vectores	array		No
└" in_scope	booleano	Si las consultas deben restringirse al uso de los datos indexados.	No
└─ incluir_contextos	array	Propiedades de contexto de salida que se van a incluir en la respuesta. De forma predeterminada, se solicitarán citas e intenciones.	No	['citas', 'intención']
└" index_name	cuerda / cadena		No
└" max_search_queries	entero	Número máximo de consultas reescritas que se deben enviar al proveedor de búsqueda para un único mensaje de usuario. De forma predeterminada, el sistema realizará una determinación automática.	No
└" query_type	enum	Valores posibles: simple, vector	No
└─ estrictez	entero	La configuración estricta del filtrado de relevancia de búsqueda. Una mayor precisión aumentará la precisión, pero la menor recuperación de la respuesta.	No
└" top_n_documents	entero	Número configurado de documentos que se van a presentar en la consulta.	No
type	enum	Identificador de tipo discriminado, que siempre es "elasticsearch". Valores posibles: elasticsearch	Sí

InpaintItem

Elemento de inpainting para un trabajo de generación de vídeo. Esto especifica el elemento multimedia que se debe usar para inpainting en la generación de vídeo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
crop_bounds	objeto	Límites de recorte para un elemento de inpainting. Especifica el área del elemento multimedia que se debe usar para inpainting.	No
└" bottom_fraction	número	Límite inferior del cuadro de recorte especificado como fracción del alto del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del alto del elemento multimedia original.	No	1
└─ fracción_izquierda	número	Límite izquierdo del cuadro de recorte especificado como fracción del ancho del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del ancho del elemento multimedia original.	No	0
└─ fracción_derecha	número	Límite derecho del cuadro de recorte especificado como fracción del ancho del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del ancho del elemento multimedia original.	No	1
└─ fracción_superior	número	Límite superior del cuadro de recorte especificado como fracción del alto del elemento multimedia original. Debe estar comprendido entre 0,0 y 1,0. Use, por ejemplo, 0,5 para la mitad del alto del elemento multimedia original.	No	0
nombre_de_archivo	cuerda / cadena	Nombre de archivo del elemento multimedia. Debe coincidir con el nombre de archivo de un archivo adjunto en esta solicitud.	Sí
frame_index	entero	Índice de marco para este elemento multimedia. Especifica el fotograma inicial en el vídeo generado resultante para este elemento de inpainting.	Sí	0
type	objeto	Tipo del elemento de inpainting.	Sí

JobStatus

Estado de un trabajo de generación de vídeo.

Propiedad	Importancia
Descripción	Estado de un trabajo de generación de vídeo.
Tipo	cuerda / cadena
Valores	preprocessing queued running processing cancelled succeeded failed

MediaItemType

Tipo del elemento de inpainting.

Propiedad	Importancia
Descripción	Tipo del elemento de inpainting.
Tipo	cuerda / cadena
Valores	image

MongoDBChatDataSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
parameters	objeto	Información de parámetros para controlar el uso del origen de datos de MongoDB.	Sí
└─ permitir_resultado_parcial	booleano	Si se configura como verdadero, el sistema permitirá que se utilicen resultados de búsqueda parciales, y la solicitud fallará si todas las consultas parciales fallan. Si no se especifica o se especifica como false, se producirá un error en la solicitud si se produce un error en alguna consulta de búsqueda.	No	Falso
└" app_name	cuerda / cadena	Nombre de la aplicación de MongoDB.	No
Autenticación └	objeto		No
└└ contraseña	cuerda / cadena		No
└─ Tipo	enum	Valores posibles: username_and_password	No
└— nombre de usuario	cuerda / cadena		No
└" collection_name	cuerda / cadena	Nombre de la colección de MongoDB.	No
└─database_name	cuerda / cadena	Nombre de la base de datos MongoDB.	No
└─ dependencia_de_incrustación	objeto	Representa un origen de vectorización que realiza llamadas de servicio público en una implementación de modelo de inserción de OpenAI Azure.	No
Autenticación └	AzureChatDataSourceApiKeyAuthenticationOptions o AzureChatDataSourceAccessTokenAuthenticationOptions	Mecanismo de autenticación que se utilizará con la fuente de vectorización basada en un endpoint. La autenticación de puntos de conexión admite la clave de API y los mecanismos de token de access.	No
└" deployment_name	cuerda / cadena	Implementación del modelo de inserción que se va a usar para la vectorización. Esta implementación debe existir dentro del mismo Azure recurso de OpenAI que la implementación del modelo que se usa para las finalizaciones de chat.	No
└─ dimensiones	entero	Número de dimensiones que se van a solicitar en las incrustaciones. Solo se admite en los modelos "text-embedding-3" y versiones posteriores.	No
└─ punto de conexión	cuerda / cadena	Especifica la dirección URL del punto de conexión de recurso desde la que se deben recuperar las incrustaciones. Debe estar en el formato de: https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. El parámetro de consulta api-version no está permitido.	No
└─ Tipo	enum	Identificador de tipo, siempre "deployment_name" para este tipo de origen de vectorización. Valores posibles: deployment_name	No
└─ punto de conexión	cuerda / cadena	Nombre del punto de conexión del clúster de MongoDB.	No
└─ mapeo_de_campos	objeto	Asignaciones de campos que se aplicarán a los datos utilizados por el origen de datos de MongoDB. Tenga en cuenta que las asignaciones de campos vectoriales y de contenido son necesarias para MongoDB.	No
└─ campos_de_contenido	array		No
└" content_fields_separator	cuerda / cadena		No
└─ campo_de_ruta_de_archivo	cuerda / cadena		No
└─ campo_título	cuerda / cadena		No
└" url_field	cuerda / cadena		No
└─ campos_vectores	array		No
└" in_scope	booleano	Si las consultas deben restringirse al uso de los datos indexados.	No
└─ incluir_contextos	array	Propiedades de contexto de salida que se van a incluir en la respuesta. De forma predeterminada, se solicitarán citas e intenciones.	No	['citas', 'intención']
└" index_name	cuerda / cadena	Nombre del índice de MongoDB.	No
└" max_search_queries	entero	Número máximo de consultas reescritas que se deben enviar al proveedor de búsqueda para un único mensaje de usuario. De forma predeterminada, el sistema realizará una determinación automática.	No
└─ estrictez	entero	La configuración estricta del filtrado de relevancia de búsqueda. Una mayor precisión aumentará la precisión, pero la menor recuperación de la respuesta.	No
└" top_n_documents	entero	Número configurado de documentos que se van a presentar en la consulta.	No
type	enum	El identificador de tipo diferenciado, que siempre es "mongo_db". Valores posibles: mongo_db	Sí

OpenAI.Annotation

Discriminador para OpenAI.Annotation

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

Valor del tipo	Schema
file_citation	OpenAI.AnnotationFileCitation
url_citation	OpenAI.AnnotationUrlCitation
file_path	OpenAI.AnnotationFilePath

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.AnnotationType		Sí

OpenAI.AnnotationFileCitation

Cita a un archivo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	cuerda / cadena	Id. del archivo.	Sí
filename	cuerda / cadena	Nombre de archivo del archivo citado.	Sí
index	entero	Índice del archivo en la lista de archivos.	Sí
type	enum	Tipo de la cita de archivo. Siempre file_citation. Valores posibles: file_citation	Sí

OpenAI.AnnotationFilePath

Ruta de acceso a un archivo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	cuerda / cadena	Id. del archivo.	Sí
index	entero	Índice del archivo en la lista de archivos.	Sí
type	enum	Tipo de la ruta de acceso del archivo. Siempre file_path. Valores posibles: file_path	Sí

OpenAI.AnnotationType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	file_citation url_citation file_path container_file_citation

OpenAI.AnnotationUrlCitation

Cita de un recurso web usado para generar una respuesta de modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
end_index	entero	Índice del último carácter de la URL citada en el mensaje.	Sí
start_index	entero	Índice del primer carácter de la cita URL en un mensaje.	Sí
title	cuerda / cadena	Título del recurso web.	Sí
type	enum	Tipo de la cita url. Siempre url_citation. Valores posibles: url_citation	Sí
URL	cuerda / cadena	Dirección URL del recurso web.	Sí

OpenAI.ApproximateLocation

Nombre	Tipo	Description	Obligatorio	Predeterminado
city	cuerda / cadena		No
country	cuerda / cadena		No
region	cuerda / cadena		No
zona horaria	cuerda / cadena		No
type	enum	Valores posibles: approximate	Sí

OpenAI.AudioResponseFormat

El formato de la salida, en una de estas opciones: json, text, srt, verbose_jsono vtt. Para gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribey gpt-4o-mini-transcribe-2025-12-15. El único formato admitido es json.

Propiedad	Importancia
Descripción	El formato de la salida, en una de estas opciones: json, text, srt, verbose_jsono vtt. Para gpt-4o-transcribe, gpt-4o-transcribe-diarize, gpt-4o-mini-transcribey gpt-4o-mini-transcribe-2025-12-15. El único formato admitido es json.
Tipo	cuerda / cadena
Valores	json text srt verbose_json vtt

OpenAI.AutoChunkingStrategyRequestParam

Estrategia predeterminada. Actualmente, esta estrategia usa un max_chunk_size_tokens de 800 y chunk_overlap_tokens de 400.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Siempre auto. Valores posibles: auto	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	cuerda / cadena	El nombre de la función que se va a llamar.	Sí

OpenAI.ChatCompletionFunctions

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	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	cuerda / cadena	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		Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON. Consulte la referencia de esquema JSON para obtener documentación sobre el formato. Al omitir parameters se define una función con una lista de parámetros vacía.	No

OpenAI.ChatCompletionMessageAudioChunk

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	cuerda / cadena		No
expires_at	entero		No
id	cuerda / cadena		No
transcript	cuerda / cadena		No

OpenAI.ChatCompletionMessageToolCall

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	objeto	Función a la que llamó el modelo.	Sí
└ Argumentos	cuerda / cadena	Argumentos para llamar a la función con, según lo generado por el modelo en formato JSON. Tenga en cuenta que el modelo no siempre genera JSON válido y puede que genere una alucinación de los parámetros no definidos por el esquema de función. Valide los argumentos del código antes de llamar a la función.	No
└─ Nombre	cuerda / cadena	El nombre de la función que se va a llamar.	No
id	cuerda / cadena	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	objeto		No
└ Argumentos	cuerda / cadena	Argumentos para llamar a la función con, según lo generado por el modelo en formato JSON. Tenga en cuenta que el modelo no siempre genera JSON válido y puede que genere una alucinación de los parámetros no definidos por el esquema de función. Valide los argumentos del código antes de llamar a la función.	No
└─ Nombre	cuerda / cadena	El nombre de la función que se va a llamar.	No
id	cuerda / cadena	Identificador de la llamada a la herramienta.	No
index	entero		Sí
type	enum	Tipo de la herramienta. Actualmente, solo se admite function. Valores posibles: function	No

OpenAI.ChatCompletionNamedToolChoice

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	objeto		Sí
└─ Nombre	cuerda / cadena	El nombre de la función que se va a llamar.	No
type	enum	Tipo de la herramienta. Actualmente, solo se admite function. Valores posibles: function	Sí

OpenAI.ChatCompletionRequestAssistantMessage

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
audio	objeto	Datos sobre una respuesta de audio anterior del modelo.	No
└─ id.	cuerda / cadena	Identificador único de una respuesta de audio anterior del modelo.	No
contenido	cadena o matriz		No
function_call	objeto	En desuso y reemplazado por tool_calls. Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo.	No
└ Argumentos	cuerda / cadena		No
└─ Nombre	cuerda / cadena		No
nombre	cuerda / cadena	Nombre opcional para el participante. Proporciona la información del modelo para diferenciar entre los participantes con el mismo rol.	No
refusal	cuerda / cadena	Mensaje de denegación por parte del asistente.	No
role	enum	Rol del autor de mensajes, en este caso assistant. Valores posibles: assistant	Sí
tool_calls	ChatCompletionMessageToolCallsItem	Llamadas a herramientas generadas por el modelo, como las llamadas a funciones.	No

OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

OpenAI.ChatCompletionRequestDeveloperMessage

Instrucciones proporcionadas por el desarrollador que el modelo debe seguir, independientemente de los mensajes enviados por el usuario. En los modelos o1 y posteriores, los mensajes developer reemplazan a los anteriores system.

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

OpenAI.ChatCompletionRequestFunctionMessage

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cuerda / cadena	Contenido del mensaje de la función.	Sí
nombre	cuerda / cadena	El nombre de la función que se va a 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:

Valor del tipo	Schema
system	OpenAI.ChatCompletionRequestSystemMessage
developer	OpenAI.ChatCompletionRequestDeveloperMessage
user	OpenAI.ChatCompletionRequestUserMessage
assistant	OpenAI.ChatCompletionRequestAssistantMessage
tool	OpenAI.ChatCompletionRequestToolMessage
function	OpenAI.ChatCompletionRequestFunctionMessage

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		No
role	objeto	Rol del autor de un mensaje	Sí

OpenAI.ChatCompletionRequestMessageContentPart

Discriminador para OpenAI.ChatCompletionRequestMessageContentPart

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

Valor del tipo	Schema
text	OpenAI.ChatCompletionRequestMessageContentPartText
image_url	OpenAI.ChatCompletionRequestMessageContentPartImage
refusal	OpenAI.ChatCompletionRequestMessageContentPartRefusal
file	OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio	OpenAI.ChatCompletionRequestMessageContentPartAudio

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ChatCompletionRequestMessageContentPartType		Sí

OpenAI.ChatCompletionRequestMessageContentPartAudio

Nombre	Tipo	Description	Obligatorio	Predeterminado
input_audio	objeto		Sí
└─ datos	cuerda / cadena	Datos de audio codificados en Base64.	No
└─ Formato	enum	Formato de los datos de audio codificados. Actualmente admite "wav" y "mp3". Valores posibles: wav, mp3	No
type	enum	Tipo del elemento de contenido. Siempre input_audio. Valores posibles: input_audio	Sí

OpenAI.ChatCompletionRequestMessageContentPartFile

Nombre	Tipo	Description	Obligatorio	Predeterminado
archivo	objeto		Sí
└" file_data	cuerda / cadena	Los datos del archivo codificados en base64, utilizados al pasar el archivo al modelo como una cadena.	No
└─ file_id	cuerda / cadena	Identificador de un archivo cargado que se va a usar como entrada.	No
└─ nombre de archivo	cuerda / cadena	Nombre del archivo, que se usa al pasar el archivo al modelo como una cadena.	No
type	enum	Tipo del elemento de contenido. Siempre file. Valores posibles: file	Sí

OpenAI.ChatCompletionRequestMessageContentPartImage

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_url	objeto		Sí
└─ detalle	enum	Especifica el nivel de detalle de la imagen. Valores posibles: auto, low, high	No
└─ URL	cuerda / cadena	Dirección URL de la imagen o datos de imagen codificados en base64.	No
type	enum	Tipo del elemento de contenido. Valores posibles: image_url	Sí

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	text file input_audio image_url refusal

OpenAI.ChatCompletionRequestSystemMessage

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		Sí
nombre	cuerda / cadena	Nombre opcional para el participante. Proporciona la información del modelo para diferenciar entre los participantes con el 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

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí
role	enum	Rol del autor de mensajes, en este caso tool. Valores posibles: tool	Sí
tool_call_id	cuerda / cadena	Llamada a la herramienta a la que va a responder este mensaje.	Sí

OpenAI.ChatCompletionRequestToolMessageContentPart

Referencias: OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

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

OpenAI.ChatCompletionRequestUserMessageContentPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
archivo	objeto		Sí
└" file_data	cuerda / cadena	Los datos del archivo codificados en base64, utilizados al pasar el archivo al modelo como una cadena.	No
└─ file_id	cuerda / cadena	Identificador de un archivo cargado que se va a usar como entrada.	No
└─ nombre de archivo	cuerda / cadena	Nombre del archivo, que se usa al pasar el archivo al modelo como una cadena.	No
image_url	objeto		Sí
└─ detalle	enum	Especifica el nivel de detalle de la imagen. Valores posibles: auto, low, high	No
└─ URL	cuerda / cadena	Dirección URL de la imagen o datos de imagen codificados en base64.	No
input_audio	objeto		Sí
└─ datos	cuerda / cadena	Datos de audio codificados en Base64.	No
└─ Formato	enum	Formato de los datos de audio codificados. Actualmente admite "wav" y "mp3". Valores posibles: wav, mp3	No
texto	cuerda / cadena	Contenido de texto.	Sí
type	enum	Tipo del elemento de contenido. Siempre file. Valores posibles: file	Sí

OpenAI.ChatCompletionRole

Rol del autor de un mensaje

Propiedad	Importancia
Descripción	Rol del autor de un mensaje
Tipo	cuerda / cadena
Valores	system developer user assistant tool function

OpenAI.ChatCompletionStreamOptions

Opciones para la respuesta de streaming. Establezca este valor solo cuando defina stream: true.

Nombre	Tipo	Description	Obligatorio	Predeterminado
include_usage	booleano	Si se establece, se transmitirá un fragmento adicional delante del mensaje data: [DONE]. El campo usage de este fragmento muestra las estadísticas de uso de tokens de toda la solicitud y el campo choices siempre será una matriz vacía. El resto de fragmentos también incluirá un campo usage, pero con un valor NULL. NOTA: Si se interrumpe la secuencia, 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
audio	objeto		No
└─ datos	cuerda / cadena		No
expires_at	entero		No
└─ id.	cuerda / cadena		No
└─ transcripción	cuerda / cadena		No
contenido	cuerda / cadena	Contenido del fragmento del mensaje.	No
function_call	objeto	En desuso y reemplazado por tool_calls. Nombre y argumentos de una función a la que se debe llamar, según lo generado por el modelo.	No
└ Argumentos	cuerda / cadena		No
└─ Nombre	cuerda / cadena		No
refusal	cuerda / cadena	Mensaje de denegación generado por el modelo.	No
role	objeto	Rol del autor de un mensaje	No
tool_calls	array		No

OpenAI.ChatCompletionTokenLogprob

Nombre	Tipo	Description	Obligatorio	Predeterminado
bytes	array	Lista de enteros que representan la representación de bytes UTF-8 del token. Resulta útil en instancias en las que los caracteres se representan mediante varios tokens y sus representaciones de bytes deben combinarse para generar la representación de texto correcta. Puede ser null si no hay ninguna representación de bytes para el token.	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	cuerda / cadena	El token.	Sí
top_logprobs	array	Lista de los tokens más probables y su probabilidad de registro, en esta posición del token. En raras ocasiones, puede que se devuelvan menos top_logprobs de los solicitados.	Sí

OpenAI.ChatCompletionTool

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 (si existe) a la que llama el modelo. 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"}} obliga 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.

Nombre	Tipo	Description	Obligatorio	Predeterminado
function	objeto		Sí
└─ Nombre	cuerda / cadena	El nombre de la función que se va a llamar.	No
type	enum	Tipo de la herramienta. Actualmente, solo se admite function. Valores posibles: function	Sí

OpenAI.ChatOutputPrediction

Representación base de la salida predicha de un modelo.

Discriminador para OpenAI.ChatOutputPrediction

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

Valor del tipo	Schema
content	OpenAI.ChatOutputPredictionContent

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ChatOutputPredictionType		Sí

OpenAI.ChatOutputPredictionContent

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		Sí
type	enum	Tipo del contenido predicho que desea proporcionar. Este tipo es actualmente siempre content. Valores posibles: content	Sí

OpenAI.ChatOutputPredictionType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	content

OpenAI.ChunkingStrategyRequestParam

Estrategia de fragmentación usada para fragmentar los archivos. Si no se establece, usará la estrategia auto.

Discriminador para OpenAI.ChunkingStrategyRequestParam

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

Valor del tipo	Schema
static	OpenAI.StaticChunkingStrategyRequestParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de estrategia de fragmentación. Valores posibles: auto, static	Sí

OpenAI.ChunkingStrategyResponseParam

Discriminador para OpenAI.ChunkingStrategyResponseParam

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

Valor del tipo	Schema
other	OpenAI.OtherChunkingStrategyResponseParam
static	OpenAI.StaticChunkingStrategyResponseParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: static, other	Sí

OpenAI.CodeInterpreterOutput

Discriminador para OpenAI.CodeInterpreterOutput

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

Valor del tipo	Schema
image	OpenAI.CodeInterpreterOutputImage
logs	OpenAI.CodeInterpreterOutputLogs

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.CodeInterpreterOutputType		Sí

OpenAI.CodeInterpreterOutputImage

Salida de la imagen del intérprete de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de la salida. Siempre 'image'. Valores posibles: image	Sí
URL	cuerda / cadena	Dirección URL de la salida de la imagen del intérprete de código.	Sí

OpenAI.CodeInterpreterOutputLogs

La salida de registros del intérprete de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
logs	cuerda / cadena	La salida de registros del intérprete de código.	Sí
type	enum	Tipo de la salida. Siempre "logs". Valores posibles: logs	Sí

OpenAI.CodeInterpreterOutputType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	logs image

OpenAI.CodeInterpreterTool

Herramienta que ejecuta código de Python para ayudar a generar una respuesta a un mensaje.

Nombre	Tipo	Description	Obligatorio	Predeterminado
container	objeto	Configuración de un contenedor de intérpretes de código. Opcionalmente, especifique los identificadores de los archivos en los que ejecutar el código.	Sí
└─ identificadores_de_archivos	array	Lista opcional de archivos cargados para que estén disponibles para tu código.	No
└─ Tipo	enum	Siempre auto. Valores posibles: auto	No
type	enum	Tipo de la herramienta de intérprete de código. Siempre code_interpreter. Valores posibles: code_interpreter	Sí

OpenAI.CodeInterpreterToolAuto

Configuración de un contenedor de intérpretes de código. Opcionalmente, especifique los identificadores de los archivos en los que ejecutar el código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
identificadores de archivos	array	Lista opcional de archivos cargados para que estén disponibles para tu código.	No
type	enum	Siempre auto. Valores posibles: auto	Sí

OpenAI.CodeInterpreterToolCallItemParam

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Código que se va a ejecutar o null si no está disponible.	Sí
container_id	cuerda / cadena	Identificador del contenedor usado para ejecutar el código.	Sí
outputs	array	Salidas generadas por el intérprete de código, como registros o imágenes. Puede ser null si no hay ninguna salida disponible.	Sí
type	enum	Valores posibles: code_interpreter_call	Sí

OpenAI.CodeInterpreterToolCallItemResource

Una llamada de herramienta para ejecutar código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Código que se va a ejecutar o null si no está disponible.	Sí
container_id	cuerda / cadena	Identificador del contenedor usado para ejecutar el código.	Sí
outputs	array	Salidas generadas por el intérprete de código, como registros o imágenes. Puede ser null si no hay ninguna salida disponible.	Sí
estado	enum	Valores posibles: in_progress, completed, incomplete, , interpreting, failed	Sí
type	enum	Valores posibles: code_interpreter_call	Sí

OpenAI.ComparisonFilter

Filtro usado para comparar una clave de atributo especificada con un valor determinado mediante una operación de comparación definida.

Nombre	Tipo	Description	Obligatorio	Predeterminado
key	cuerda / cadena	Clave que se va a comparar con el valor.	Sí
type	enum	Especifica el operador de comparación: eq, ne, gt, gte, lt, . lte - eq:Iguales - ne: no es igual a - gt: mayor que - gte: mayor o igual que - lt: menor que - lte: menor o igual que . Valores posibles: eq, ne, gt, gte, , lt, lte	Sí
valor	cadena o número o booleano		Sí

OpenAI.CompletionUsage

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
completion_tokens	entero	Número de tokens en la finalización generada.	Sí	0
completion_tokens_details	objeto	Desglose de los tokens que se usan en una finalización.	No
└─ tokens_de_prediccion_aceptados	entero	Cuando se usan salidas predichas, el número de tokens de la predicción que apareció en la finalización.	No	0
└" audio_tokens	entero	Tokens de entrada de audio generados por el modelo.	No	0
─ reasoning_tokens	entero	Tokens generados por el modelo para razonamiento.	No	0
└─ tokens_de_prediccion_rechazados	entero	Cuando se usan salidas predichas, el número de tokens de la predicción que no aparecen en la finalización. Sin embargo, al igual que los tokens de razonamiento, estos tokens todavía se cuentan en los tokens de finalización total con fines de facturación, salida y límites de ventana de contexto.	No	0
prompt_tokens	entero	Número de tokens en el símbolo del sistema.	Sí	0
prompt_tokens_details	objeto	Desglose de los tokens usados en la solicitud.	No
└" audio_tokens	entero	Tokens de entrada de audio presentes en el símbolo del sistema.	No	0
└─ tokens en caché	entero	Tokens almacenados en caché presentes en el mensaje.	No	0
total_tokens	entero	Número total de tokens usados en la solicitud (solicitud + finalización).	Sí	0

OpenAI.CompoundFilter

Combine varios filtros mediante and o or.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filters	array	Conjunto de filtros para combinar. Los elementos pueden ser ComparisonFilter o CompoundFilter.	Sí
type	enum	Tipo de operación: and o or. Valores posibles: and, or	Sí

OpenAI.ComputerAction

Discriminador para OpenAI.ComputerAction

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ComputerActionType		Sí

OpenAI.ComputerActionClick

Una acción de clic.

Nombre	Tipo	Description	Obligatorio	Predeterminado
button	enum	Indica qué botón del mouse se ha presionado durante el clic. Uno de estos valores: left, right, wheel, back o forward. Valores posibles: left, right, wheel, , back, forward	Sí
type	enum	Especifica el tipo de evento. Para una acción de clic, esta propiedad siempre se establece en click. Valores posibles: click	Sí
x	entero	Coordenada x donde se produjo el clic.	Sí
y	entero	Coordenada y donde se produjo el clic.	Sí

OpenAI.ComputerActionDoubleClick

Una acción de doble clic.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de doble clic, esta propiedad siempre se establece en double_click. Valores posibles: double_click	Sí
x	entero	Coordenada x donde se produjo el doble clic.	Sí
y	entero	Coordenada y donde se produjo el doble clic.	Sí

OpenAI.ComputerActionDrag

Una acción de arrastre.

Nombre	Tipo	Description	Obligatorio	Predeterminado
ruta	array	Matriz de coordenadas que representa la trayectoria de la acción de arrastre. Las coordenadas aparecerán como una matriz de objetos, por ejemplo,{ x: 100, y: 200 }, { x: 200, y: 300 }	Sí
type	enum	Especifica el tipo de evento. En el caso de una acción de arrastre, esta propiedad siempre se establece en drag. Valores posibles: drag	Sí

OpenAI.ComputerActionKeyPress

Una colección de teclas presiona el modelo que desea realizar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
keys	array	La combinación de teclas que solicita que se presione el modelo. Se trata de una matriz de cadenas, cada una que representa una clave.	Sí
type	enum	Especifica el tipo de evento. Para una acción de keypress, esta propiedad siempre se establece en keypress. Valores posibles: keypress	Sí

OpenAI.ComputerActionMove

Una acción de movimiento del mouse.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de movimiento, esta propiedad siempre se establece en move. Valores posibles: move	Sí
x	entero	Coordenada x a la que se va a mover.	Sí
y	entero	Coordenada y a la que se va a mover.	Sí

OpenAI.ComputerActionScreenshot

Acción de captura de pantalla.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de captura de pantalla, esta propiedad siempre se establece en screenshot. Valores posibles: screenshot	Sí

OpenAI.ComputerActionScroll

Una acción de desplazamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
scroll_x	entero	Distancia de desplazamiento horizontal.	Sí
scroll_y	entero	Distancia de desplazamiento vertical.	Sí
type	enum	Especifica el tipo de evento. Para una acción de desplazamiento, esta propiedad siempre se establece en scroll. Valores posibles: scroll	Sí
x	entero	Coordenada x donde se produjo el desplazamiento.	Sí
y	entero	Coordenada y donde se produjo el desplazamiento.	Sí

OpenAI.ComputerActionType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	screenshot click double_click scroll type wait keypress drag move

OpenAI.ComputerActionTypeKeys

Acción para escribir texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena	Texto que se va a escribir.	Sí
type	enum	Especifica el tipo de evento. Para una acción de tipo, esta propiedad siempre se establece en type. Valores posibles: type	Sí

OpenAI.ComputerActionWait

Una acción de espera.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Especifica el tipo de evento. Para una acción de espera, esta propiedad siempre se establece en wait. Valores posibles: wait	Sí

OpenAI.ComputerToolCallItemParam

Una llamada de herramienta a una herramienta de uso de equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.ComputerAction		Sí
call_id	cuerda / cadena	Identificador que se usa al responder a la llamada de herramienta con salida.	Sí
pending_safety_checks	array	Las comprobaciones de seguridad pendientes para la llamada al equipo.	Sí
type	enum	Valores posibles: computer_call	Sí

OpenAI.ComputerToolCallItemResource

Una llamada de herramienta a una herramienta de uso de equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.ComputerAction		Sí
call_id	cuerda / cadena	Identificador que se usa al responder a la llamada de herramienta con salida.	Sí
pending_safety_checks	array	Las comprobaciones de seguridad pendientes para la llamada al equipo.	Sí
estado	enum	Estado del elemento. Uno dein_progress, completed o incomplete. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Valores posibles: computer_call	Sí

OpenAI.ComputerToolCallOutputItemOutput

Discriminador para OpenAI.ComputerToolCallOutputItemOutput

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

Valor del tipo	Schema
computer_screenshot	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ComputerToolCallOutputItemOutputType	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.	Sí

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Nombre	Tipo	Description	Obligatorio	Predeterminado
ID del archivo	cuerda / cadena		No
image_url	cuerda / cadena		No
type	enum	Valores posibles: computer_screenshot	Sí

OpenAI.ComputerToolCallOutputItemOutputType

Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.

Propiedad	Importancia
Descripción	Imagen de captura de pantalla del equipo que se usa con la herramienta de uso del equipo.
Tipo	cuerda / cadena
Valores	computer_screenshot

OpenAI.ComputerToolCallOutputItemParam

Salida de una llamada a una herramienta de equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acknowledged_safety_checks	array	Las comprobaciones de seguridad notificadas por la API que el desarrollador ha confirmado.	No
call_id	cuerda / cadena	Identificador de la llamada a la herramienta de equipo que generó la salida.	Sí
output	OpenAI.ComputerToolCallOutputItemOutput		Sí
type	enum	Valores posibles: computer_call_output	Sí

OpenAI.ComputerToolCallOutputItemResource

Salida de una llamada a una herramienta de equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acknowledged_safety_checks	array	Las comprobaciones de seguridad notificadas por la API que el desarrollador ha confirmado.	No
call_id	cuerda / cadena	Identificador de la llamada a la herramienta de equipo que generó la salida.	Sí
output	OpenAI.ComputerToolCallOutputItemOutput		Sí
estado	enum	Estado del elemento. Uno dein_progress, completed o incomplete. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Valores posibles: computer_call_output	Sí

OpenAI.ComputerToolCallSafetyCheck

Una comprobación de seguridad pendiente para la llamada del equipo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Tipo de comprobación de seguridad pendiente.	Sí
id	cuerda / cadena	Identificador de la comprobación de seguridad pendiente.	Sí
Mensaje	cuerda / cadena	Detalles sobre la comprobación de seguridad pendiente.	Sí

OpenAI.HerramientaDeVistaPreviaDeUsoDeComputadora

Herramienta que controla un equipo virtual.

Nombre	Tipo	Description	Obligatorio	Predeterminado
altura_de_pantalla	entero	La altura de la pantalla del ordenador.	Sí
ancho_de_pantalla	entero	Ancho de la pantalla del equipo.	Sí
environment	enum	Tipo de entorno de equipo que se va a controlar. Valores posibles: windows, mac, linux, , ubuntu, browser	Sí
type	enum	Tipo de la herramienta para el uso de la computadora. Siempre computer_use_preview. Valores posibles: computer_use_preview	Sí

OpenAI.Coordinate

Un par de coordenadas x/y, por ejemplo { x: 100, y: 200 }, .

Nombre	Tipo	Description	Obligatorio	Predeterminado
x	entero	Coordenada x.	Sí
y	entero	La coordenada y.	Sí

OpenAI.CreateEmbeddingResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array	La lista de inserciones generadas por el modelo.	Sí
modelo	cuerda / cadena	Nombre del modelo usado para generar la inserción.	Sí
objeto	enum	Tipo de objeto, que siempre es "lista". Valores posibles: list	Sí
usage	objeto	Información de uso de la solicitud.	Sí
└" prompt_tokens	entero	Número de tokens usados por el símbolo del sistema.	No
└" total_tokens	entero	Número total de tokens usados por la solicitud.	No

OpenAI.CreateEvalItem

Mensaje de chat que constituye el aviso o el contexto. Puede incluir referencias de variables al espacio de nombres item, es decir, {{item.name}}.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o OpenAI.EvalItemContent	Entradas de texto en el modelo: puede contener cadenas de plantilla.	Sí
role	enum	Rol de la entrada del mensaje. Uno de los siguientes: user, assistant, system o developer. Valores posibles: user, assistant, system, developer	Sí
type	enum	Tipo de la entrada del mensaje. Siempre message. Valores posibles: message	No

OpenAI.CreateEvalRunRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
fuente_de_datos	objeto		Sí
└─ Tipo	OpenAI.EvalRunDataSourceType		No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre de la ejecución.	No

OpenAI.CreateFineTuningJobRequest

Modelos válidos:

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

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	objeto	Hiperparámetros usados para el trabajo de ajuste preciso. Este valor ahora está en desuso en favor de method y debe pasarse bajo el parámetro method.	No
└─ tamaño del lote (batch_size)	enum	Valores posibles: auto	No
"└─ learning_rate_multiplier"	enum	Valores posibles: auto	No
├─ n_epochs	enum	Valores posibles: auto	No
Integraciones	array	Lista de integraciones que se habilitarán para el trabajo de ajuste preciso.	No
metadata	objeto	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.	No
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
modelo	string (consulte los modelos válidos a continuación)	Nombre del modelo que se va a ajustar.	Sí
seed	entero	La semilla controla la reproducibilidad del trabajo. Pasar los mismos parámetros de inicialización y trabajo debe generar los mismos resultados, pero puede diferir en raras ocasiones. Si no se especifica una semilla, se generará una para ti.	No
sufijo	cuerda / cadena	Cadena de hasta 64 caracteres que se agregarán al nombre del modelo ajustado. Por ejemplo, un suffix de "custom-model-name" produciría un nombre de modelo como ft:gpt-4o-mini:openai:custom-model-name:7p4lURel.	No	Ninguno
archivo_de_entrenamiento	cuerda / cadena	Identificador de un archivo cargado que contiene datos de entrenamiento. El conjunto de datos debe tener el formato JSONL. Además, debe cargar su archivo con el propósito de fine-tune. El contenido del archivo debe diferir en función de si el modelo usa el formato de chat, finalizaciones o si el método de ajuste utiliza el formato de preferencia.	Sí
archivo_de_validación	cuerda / cadena	El Id. de un archivo cargado que contenga datos de validación. Si proporciona este archivo, los datos se usan para generar métricas de validación periódicamente durante el ajuste fino. Estas métricas se pueden ver en el archivo de resultados de ajuste fino. Los mismos datos no deben estar presentes en los archivos de entrenamiento y validación. El conjunto de datos debe tener el formato de un archivo JSONL. Debe cargar el archivo con el propósito fine-tune.	No

OpenAI.CreateFineTuningJobRequestIntegration

Discriminador para OpenAI.CreateFineTuningJobRequestIntegration

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

Valor del tipo	Schema
wandb	OpenAI.CreateFineTuningJobRequestWandbIntegration

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string (consulte los modelos válidos a continuación)		Sí

OpenAI.CreateFineTuningJobRequestWandbIntegration

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Valores posibles: wandb	Sí
wandb	objeto		Sí
└─ entidad	cuerda / cadena		No
└─ Nombre	cuerda / cadena		No
└" project	cuerda / cadena		No
└─ etiquetas	array		No

OpenAI.CreateVectorStoreFileBatchRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Estrategia de fragmentación usada para fragmentar los archivos. Si no se establece, usará la estrategia auto.	No
identificadores de archivos	array	Lista de identificadores de archivo que debe usar el almacén de vectores. Útil para herramientas como file_search que pueden access archivos.	Sí

OpenAI.CreateVectorStoreFileRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	Estrategia de fragmentación usada para fragmentar los archivos. Si no se establece, usará la estrategia auto.	No
ID del archivo	cuerda / cadena	Identificador de archivo que debe usar el almacén de vectores. Útil para herramientas como file_search que pueden access archivos.	Sí

OpenAI.CreateVectorStoreRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
chunking_strategy	objeto	Estrategia predeterminada. Actualmente, esta estrategia usa un max_chunk_size_tokens de 800 y chunk_overlap_tokens de 400.	No
└─ estático	OpenAI.StaticChunkingStrategy		No
└─ Tipo	enum	Siempre static. Valores posibles: static	No
expires_after	OpenAI.VectorStoreExpirationAfter	Directiva de expiración de un almacén de vectores.	No
identificadores de archivos	array	Lista de identificadores de archivo que debe usar el almacén de vectores. Útil para herramientas como file_search que pueden access archivos.	No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre del almacén de vectores.	No

OpenAI.DeleteFileResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	booleano		Sí
id	cuerda / cadena		Sí
objeto	enum	Valores posibles: file	Sí

OpenAI.DeleteVectorStoreFileResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	booleano		Sí
id	cuerda / cadena		Sí
objeto	enum	Valores posibles: vector_store.file.deleted	Sí

OpenAI.DeleteVectorStoreResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
eliminado	booleano		Sí
id	cuerda / cadena		Sí
objeto	enum	Valores posibles: vector_store.deleted	Sí

OpenAI.Embedding

Representa un vector de inserción devuelto por el punto de conexión de inserción.

Nombre	Tipo	Description	Obligatorio	Predeterminado
embedding	matriz o cadena		Sí
index	entero	Índice de la inserción en la lista de inserciones.	Sí
objeto	enum	El tipo de objeto, que siempre es "embedding". Valores posibles: embedding	Sí

OpenAI.Eval

Objeto Eval con una configuración de origen de datos y criterios de prueba. Una Evaluación representa una tarea que debe realizarse para la integración de LLM. Como, por ejemplo:

• Mejora de la calidad de mi bot de chat
• Ver cómo mi bot de chat controla el soporte técnico al cliente
• Compruebe si o4-mini es mejor en mi caso que gpt-4o

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó la ejecución.	Sí
configuración_de_fuente_de_datos	objeto		Sí
└─ Tipo	OpenAI.EvalDataSourceConfigType		No
id	cuerda / cadena	Identificador único de la evaluación.	Sí
metadata	objeto	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.	Sí
nombre	cuerda / cadena	Nombre de la evaluación.	Sí
objeto	enum	Tipo de objeto. Valores posibles: eval	Sí
criterios_de_prueba	array	Lista de criterios de prueba.	Sí	Ninguno

OpenAI.EvalApiError

Objeto que representa una respuesta de error de la API de Eval.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Código de error.	Sí
Mensaje	cuerda / cadena	El mensaje de error.	Sí

OpenAI.EvalCompletionsRunDataSourceParams

Objeto CompletionsRunDataSource que describe una configuración de muestreo del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mensajes de entrada	objeto		No
└─ referencia_elemento	cuerda / cadena	Referencia a una variable en el espacio de nombres item. Es decir, "item.input_trajectory"	No
└─ Plantilla	array	Una lista de mensajes de chat que forman el indicador o el contexto. Puede incluir referencias de variables al espacio de nombres item, es decir, {{item.name}}.	No
└─ Tipo	enum	Tipo de mensajes de entrada. Siempre item_reference. Valores posibles: item_reference	No
modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
parámetros_de_muestreo	AzureEvalAPICompletionsSamplingParams		No
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ creado_después	entero	Marca de tiempo opcional de Unix para filtrar los elementos creados después de este tiempo.	No
└─ creado_antes	entero	Marca de tiempo opcional de Unix para filtrar los elementos creados antes de esta hora.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ límite	entero	Número máximo opcional de elementos que se van a devolver.	No
Metadatos └	objeto	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.	No
└─ modelo	cuerda / cadena	Un modelo opcional para filtrar por (por ejemplo, "gpt-4o").	No
└─ Tipo	enum	Tipo de origen. Siempre stored_completions. Valores posibles: stored_completions	No
type	enum	Tipo de origen de datos de ejecución. Siempre completions. Valores posibles: completions	Sí

OpenAI.EvalCustomDataSourceConfigParams

Objeto CustomDataSourceConfig que define el esquema del origen de datos usado para las ejecuciones de evaluación. Este esquema se usa para definir la forma de los datos que serán:

• Se usa para definir los criterios de prueba y
• Qué datos son necesarios al crear una ejecución

Nombre	Tipo	Description	Obligatorio	Predeterminado
incluir_esquema_de_muestra	booleano	Si la evaluación debe esperar que rellene el espacio de nombres de ejemplo (por ejemplo, generando respuestas a partir de su origen de datos).	No	Falso
esquema_de_elemento	objeto	Esquema json para cada fila del origen de datos.	Sí
type	enum	Tipo de origen de datos. Siempre custom. Valores posibles: custom	Sí

OpenAI.EvalCustomDataSourceConfigResource

CustomDataSourceConfig que especifica el esquema del item y, opcionalmente, sample de espacios de nombres. El esquema de respuesta define la forma de los datos que serán:

• Se usa para definir los criterios de prueba y
• Qué datos son necesarios al crear una ejecución

Nombre	Tipo	Description	Obligatorio	Predeterminado
schema	objeto	Esquema JSON para los elementos de la fuente de datos de ejecución. Obtenga información sobre cómo compilar esquemas JSON aquí.	Sí
type	enum	Tipo de origen de datos. Siempre custom. Valores posibles: custom	Sí

OpenAI.EvalDataSourceConfigParams

Discriminador para OpenAI.EvalDataSourceConfigParams

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

Valor del tipo	Schema
custom	OpenAI.EvalCustomDataSourceConfigParams
logs	OpenAI.EvalLogsDataSourceConfigParams
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalDataSourceConfigType		Sí

OpenAI.EvalDataSourceConfigResource

Discriminador para OpenAI.EvalDataSourceConfigResource

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

Valor del tipo	Schema
custom	OpenAI.EvalCustomDataSourceConfigResource
stored_completions	OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs	OpenAI.EvalLogsDataSourceConfigResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalDataSourceConfigType		Sí

OpenAI.EvalDataSourceConfigType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	custom logs stored_completions

OpenAI.EvalGraderLabelModelParams

Objeto LabelModelGrader que usa un modelo para asignar etiquetas a cada elemento de la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	array	Una lista de mensajes de chat que forman el indicador o el contexto. Puede incluir referencias de variables al espacio de nombres item, es decir, {{item.name}}.	Sí
labels	array	Las etiquetas para clasificar cada elemento en la evaluación.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
passing_labels	array	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre es label_model. Valores posibles: label_model	Sí

OpenAI.EvalGraderLabelModelResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	array		Sí
labels	array	Etiquetas que se van a asignar a cada elemento de la evaluación.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
passing_labels	array	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre es label_model. Valores posibles: label_model	Sí

OpenAI.EvalGraderParams

Discriminador para OpenAI.EvalGraderParams

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

Valor del tipo	Schema
label_model	OpenAI.EvalGraderLabelModelParams
string_check	OpenAI.EvalGraderStringCheckParams
text_similarity	OpenAI.EvalGraderTextSimilarityParams
python	OpenAI.EvalGraderPythonParams
score_model	OpenAI.EvalGraderScoreModelParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.GraderType		Sí

OpenAI.EvalGraderPythonParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	número	Umbral de la puntuación.	No
source	cuerda / cadena	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre es python. Valores posibles: python	Sí

OpenAI.EvalGraderPythonResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	número	Umbral de la puntuación.	No
source	cuerda / cadena	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre es python. Valores posibles: python	Sí

OpenAI.EvalGraderResource

Discriminador para OpenAI.EvalGraderResource

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

Valor del tipo	Schema
label_model	OpenAI.EvalGraderLabelModelResource
text_similarity	OpenAI.EvalGraderTextSimilarityResource
python	OpenAI.EvalGraderPythonResource
score_model	OpenAI.EvalGraderScoreModelResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.GraderType		Sí

OpenAI.EvalGraderScoreModelParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	número	Umbral de la puntuación.	No
rango	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
type	enum	Tipo de objeto, que siempre es score_model. Valores posibles: score_model	Sí

OpenAI.EvalGraderScoreModelResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	número	Umbral de la puntuación.	No
rango	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
type	enum	Tipo de objeto, que siempre es score_model. Valores posibles: score_model	Sí

OpenAI.EvalGraderStringCheckParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	cuerda / cadena	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
operation	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	Sí
referencia	cuerda / cadena	Texto de referencia. Esto puede incluir cadenas de plantilla.	Sí
type	enum	Tipo de objeto, que siempre es string_check. Valores posibles: string_check	Sí

OpenAI.EvalGraderTextSimilarityParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Sí
entrada	cuerda / cadena	Texto que se va a calificar.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	número	Umbral de la puntuación.	Sí
referencia	cuerda / cadena	Texto con el que se va a calificar.	Sí
type	enum	Tipo de calificador. Valores posibles: text_similarity	Sí

OpenAI.EvalGraderTextSimilarityResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Sí
entrada	cuerda / cadena	Texto que se va a calificar.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
pass_threshold	número	Umbral de la puntuación.	Sí
referencia	cuerda / cadena	Texto con el que se va a calificar.	Sí
type	enum	Tipo de calificador. Valores posibles: text_similarity	Sí

OpenAI.EvalItem

Una entrada de mensaje al modelo con un rol que indica el seguimiento de instrucciones dentro de una jerarquía. Las instrucciones dadas con el developer rol o system tienen prioridad sobre las instrucciones dadas con el user rol. Los mensajes con el rol assistant se presumen generados por el modelo en interacciones anteriores.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	objeto		Sí
└─ Tipo	OpenAI.EvalItemContentType		No
role	enum	Rol de la entrada del mensaje. Uno de los siguientes: user, assistant, system o developer. Valores posibles: user, assistant, system, developer	Sí
type	enum	Tipo de la entrada del mensaje. Siempre message. Valores posibles: message	No

OpenAI.EvalItemContent

Discriminador para OpenAI.EvalItemContent

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

Valor del tipo	Schema
input_text	OpenAI.EvalItemContentInputText
output_text	OpenAI.EvalItemContentOutputText

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalItemContentType		Sí

OpenAI.EvalItemContentInputText

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena		Sí
type	enum	Valores posibles: input_text	Sí

OpenAI.EvalItemContentOutputText

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena		Sí
type	enum	Valores posibles: output_text	Sí

OpenAI.EvalItemContentType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	input_text output_text

OpenAI.EvalJsonlRunDataSourceParams

Un objeto JsonlRunDataSource que especifica un archivo JSONL que coincide con la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ Tipo	enum	Tipo de origen jsonl. Siempre file_id. Valores posibles: file_id	No
type	enum	Tipo de origen de datos. Siempre jsonl. Valores posibles: jsonl	Sí

OpenAI.EvalList

Objeto que representa una lista de valores.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array	Una matriz de objetos eval.	Sí
first_id	cuerda / cadena	El identificador de la primera evaluación del arreglo de datos.	Sí
has_more	booleano	Indica si hay más evaluaciones disponibles.	Sí
last_id	cuerda / cadena	Identificador de la última evaluación en el array de datos.	Sí
objeto	enum	El tipo de este objeto. Siempre se establece en "list". Valores posibles: list	Sí

OpenAI.EvalLogsDataSourceConfigParams

Una configuración del origen de datos que especifica la propiedad de metadatos de la consulta de registros. Esto suele ser metadatos como usecase=chatbot o prompt-version=v2, etc.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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.	No
type	enum	Tipo de origen de datos. Siempre logs. Valores posibles: logs	Sí

OpenAI.EvalLogsDataSourceConfigResource

Un LogsDataSourceConfig que especifica la propiedad de metadatos de la consulta de registros. Esto suele ser metadatos como usecase=chatbot o prompt-version=v2, etc. El esquema devuelto por esta configuración del origen de datos se usa para definir qué variables están disponibles en las evaluaciones. item y sample se definen al usar esta configuración del origen de datos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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.	Sí
schema	objeto	Esquema JSON para los elementos de la fuente de datos de ejecución. Obtenga información sobre cómo compilar esquemas JSON aquí.	Sí
type	enum	Tipo de origen de datos. Siempre logs. Valores posibles: logs	Sí

OpenAI.EvalResponsesRunDataSourceParams

Objeto ResponsesRunDataSource que describe una configuración de muestreo del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
mensajes de entrada	objeto		No
└─ referencia_elemento	cuerda / cadena	Referencia a una variable en el espacio de nombres item. Es decir, "item.name"	No
└─ Plantilla	array	Una lista de mensajes de chat que forman el indicador o el contexto. Puede incluir referencias de variables al espacio de nombres item, es decir, {{item.name}}.	No
└─ Tipo	enum	Tipo de mensajes de entrada. Siempre item_reference. Valores posibles: item_reference	No
modelo	cuerda / cadena	Nombre del modelo que se va a usar para generar finalizaciones (por ejemplo, "o3-mini").	No
parámetros_de_muestreo	AzureEvalAPIResponseSamplingParams		No
source	objeto		Sí
└─ Contenido	array	Contenido del archivo jsonl.	No
└─ creado_después	entero	Incluya solo los elementos creados después de esta marca de tiempo (inclusivo). Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ creado_antes	entero	Incluya solo los elementos creados antes de esta marca de tiempo (inclusivo). Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ id.	cuerda / cadena	Identificador del archivo.	No
└─ instrucciones_búsqueda	cuerda / cadena	Cadena opcional para buscar en el campo "instructions". Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
Metadatos └	objeto	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.	No
└─ modelo	cuerda / cadena	Nombre del modelo para el que buscar las respuestas. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ esfuerzo_de_razonamiento	OpenAI.ReasoningEffort	Parámetro de esfuerzo de razonamiento opcional. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ Temperatura	número	Temperatura de muestreo. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ herramientas	array	Lista de nombres de herramientas. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ top_p	número	Parámetro de muestreo de núcleo. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
└─ Tipo	enum	Tipo de origen de datos de ejecución. Siempre responses. Valores posibles: responses	No
└─ usuarios	array	Lista de identificadores de usuario. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
type	enum	Tipo de origen de datos de ejecución. Siempre responses. Valores posibles: responses	Sí

OpenAI.EvalRun

Esquema que representa una ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) cuando se creó el proceso de evaluación.	Sí
fuente_de_datos	objeto		Sí
└─ Tipo	OpenAI.EvalRunDataSourceType		No
error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	Sí
eval_id	cuerda / cadena	Identificador de la evaluación asociada.	Sí
id	cuerda / cadena	Identificador único de la ejecución de la evaluación.	Sí
metadata	objeto	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.	Sí
modelo	cuerda / cadena	Modelo que se evalúa, si procede.	Sí
nombre	cuerda / cadena	Nombre de la ejecución de evaluación.	Sí
objeto	enum	Tipo del objeto. Siempre "eval.run". Valores posibles: eval.run	Sí
per_model_usage	array	Estadísticas de uso de cada modelo durante la ejecución de evaluación.	Sí
resultados_por_criterios_de_pruebas	array	Resultados por criterios de prueba aplicados durante la ejecución de la evaluación.	Sí
report_url	cuerda / cadena	Dirección URL del informe de ejecución de evaluación representado en el panel de la interfaz de usuario.	Sí
conteo_de_resultados	objeto	Contadores que resumen los resultados de la ejecución de evaluación.	Sí
Errores └	entero	Número de elementos de salida que provocaron un error.	No
└─ fallido	entero	Número de elementos de salida que no pudieron pasar la evaluación.	No
└─ aprobado	entero	Número de elementos de salida que pasaron la evaluación.	No
└─ total	entero	Número total de elementos de salida ejecutados.	No
estado	cuerda / cadena	Estado de la ejecución de la evaluación.	Sí

OpenAI.EvalRunDataContentSource

Discriminador para OpenAI.EvalRunDataContentSource

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

Valor del tipo	Schema
file_id	OpenAI.EvalRunFileIdDataContentSource
stored_completions	OpenAI.EvalRunStoredCompletionsDataContentSource
responses	OpenAI.EvalRunResponsesDataContentSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalRunDataContentSourceType		Sí

OpenAI.EvalRunDataContentSourceType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	file_id file_content stored_completions responses

OpenAI.EvalRunDataSourceCompletionsResource

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

OpenAI.EvalRunDataSourceJsonlResource

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

OpenAI.EvalRunDataSourceParams

Discriminador para OpenAI.EvalRunDataSourceParams

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

Valor del tipo	Schema
jsonl	OpenAI.EvalJsonlRunDataSourceParams
completions	OpenAI.EvalCompletionsRunDataSourceParams
responses	OpenAI.EvalResponsesRunDataSourceParams

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalRunDataSourceType		Sí

OpenAI.EvalRunDataSourceResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.EvalRunDataSourceType		Sí

OpenAI.EvalRunDataSourceResponsesResource

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

OpenAI.EvalRunDataSourceType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	jsonl completions responses

OpenAI.EvalRunFileContentDataContentSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido del archivo jsonl.	Sí
type	enum	Tipo de origen jsonl. Siempre file_content. Valores posibles: file_content	Sí

OpenAI.EvalRunFileIdDataContentSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	cuerda / cadena	Identificador del archivo.	Sí
type	enum	Tipo de origen jsonl. Siempre file_id. Valores posibles: file_id	Sí

OpenAI.EvalRunList

Objeto que representa una lista de ejecuciones para una evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array	Matriz de objetos de ejecución de evaluación.	Sí
first_id	cuerda / cadena	Identificador de la primera ejecución de evaluación en la matriz de datos.	Sí
has_more	booleano	Indica si hay más evaluaciones disponibles.	Sí
last_id	cuerda / cadena	Identificador de la última ejecución de evaluación en la matriz de datos.	Sí
objeto	enum	El tipo de este objeto. Siempre se establece en "list". Valores posibles: list	Sí

OpenAI.EvalRunOutputItem

Esquema que representa un elemento de salida de una ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) cuando se creó el proceso de evaluación.	Sí
elemento_fuente_de_datos	objeto	Detalles del elemento de origen de datos de entrada.	Sí
id_del_elemento_fuente_de_datos	entero	Identificador del elemento de origen de datos.	Sí
eval_id	cuerda / cadena	Identificador del grupo de evaluación.	Sí
id	cuerda / cadena	Identificador único del elemento de salida del proceso de evaluación.	Sí
objeto	enum	Tipo del objeto. Siempre "eval.run.output_item". Valores posibles: eval.run.output_item	Sí
results	array	Una lista de resultados de la ejecución de la evaluación.	Sí
identificador_de_ejecución	cuerda / cadena	Identificador de la ejecución de evaluación asociada a este elemento de salida.	Sí
muestra	objeto	Un ejemplo que contiene la entrada y salida de la evaluación realizada.	Sí
└─ Error	OpenAI.EvalApiError	Objeto que representa una respuesta de error de la API de Eval.	No
└─ razón_de_finalización	cuerda / cadena	Motivo por el que finalizó la generación de muestras.	No
└─ Entrada	array	Matriz de mensajes de entrada.	No
└" max_completion_tokens	entero	Número máximo de tokens permitidos para la finalización.	No
└─ modelo	cuerda / cadena	Modelo usado para generar el ejemplo.	No
└─ salida	array	Matriz de mensajes de salida.	No
└— semilla	entero	La semilla utilizada para generar la muestra.	No
└─ Temperatura	número	Temperatura de muestreo utilizada.	No
└─ top_p	número	Valor de top_p usado para el muestreo.	No
└─ uso	objeto	Detalles de uso de tokens para el ejemplo.	No
└─ tokens en caché	entero	Número de tokens recuperados de la memoria caché.	No
└─ tokens_de_finalización	entero	Número de tokens de finalización generados.	No
└" prompt_tokens	entero	Número de tokens de solicitud usados.	No
└" total_tokens	entero	Número total de tokens usados.	No
estado	cuerda / cadena	Estado de la ejecución de la evaluación.	Sí

OpenAI.EvalRunOutputItemList

Objeto que representa una lista de elementos de salida para una ejecución de evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array	Una matriz de objetos de elementos de salida de la ejecución de evaluación.	Sí
first_id	cuerda / cadena	Identificador del primer elemento de salida de la evaluación en la matriz de datos.	Sí
has_more	booleano	Indica si hay más elementos de salida de ejecución de evaluación disponibles.	Sí
last_id	cuerda / cadena	Identificador del último elemento de salida de la evaluación en la matriz de datos.	Sí
objeto	enum	El tipo de este objeto. Siempre se establece en "list". Valores posibles: list	Sí

OpenAI.EvalRunResponsesDataContentSource

Objeto EvalResponsesSource que describe una configuración de origen de datos de ejecución.

Nombre	Tipo	Description	Obligatorio	Predeterminado
created_after	entero	Incluya solo los elementos creados después de esta marca de tiempo (inclusivo). Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
creado_antes_de	entero	Incluya solo los elementos creados antes de esta marca de tiempo (inclusivo). Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
instructions_search	cuerda / cadena	Cadena opcional para buscar en el campo "instructions". Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
metadata	objeto	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.	No
modelo	cuerda / cadena	Nombre del modelo para el que buscar las respuestas. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
esfuerzo de razonamiento	objeto	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
temperatura	número	Temperatura de muestreo. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
herramientas	array	Lista de nombres de herramientas. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
top_p	número	Parámetro de muestreo de núcleo. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No
type	enum	Tipo de origen de datos de ejecución. Siempre responses. Valores posibles: responses	Sí
users	array	Lista de identificadores de usuario. Se trata de un parámetro de consulta que se usa para seleccionar respuestas.	No

OpenAI.EvalRunStoredCompletionsDataContentSource

Una configuración StoredCompletionsRunDataSource que describe un conjunto de filtros

Nombre	Tipo	Description	Obligatorio	Predeterminado
created_after	entero	Marca de tiempo opcional de Unix para filtrar los elementos creados después de este tiempo.	No
creado_antes_de	entero	Marca de tiempo opcional de Unix para filtrar los elementos creados antes de esta hora.	No
limit	entero	Número máximo opcional de elementos que se van a devolver.	No
metadata	objeto	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.	Sí
modelo	cuerda / cadena	Un modelo opcional para filtrar por (por ejemplo, "gpt-4o").	No
type	enum	Tipo de origen. Siempre stored_completions. Valores posibles: stored_completions	Sí

OpenAI.EvalStoredCompletionsDataSourceConfigParams

En desuso en favor de LogsDataSourceConfig.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	Filtros de metadatos para el origen de datos de finalizaciones almacenadas.	No
type	enum	Tipo de origen de datos. Siempre stored_completions. Valores posibles: stored_completions	Sí

OpenAI.EvalStoredCompletionsDataSourceConfigResource

En desuso en favor de LogsDataSourceConfig.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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.	Sí
schema	objeto	Esquema JSON para los elementos de la fuente de datos de ejecución. Obtenga información sobre cómo compilar esquemas JSON aquí.	Sí
type	enum	Tipo de origen de datos. Siempre stored_completions. Valores posibles: stored_completions	Sí

OpenAI.FileSearchTool

Herramienta que busca contenido relevante de los archivos cargados.

Nombre	Tipo	Description	Obligatorio	Predeterminado
filters	objeto		No
número_máximo_de_resultados	entero	El número máximo de resultados que se devolverán. Este número debe estar comprendido entre 1 y 50 inclusive.	No
opciones_de_clasificación	objeto		No
└─ clasificador	enum	Clasificador que se va a usar para la búsqueda de archivos. Valores posibles: auto, default-2024-11-15	No
└─ umbral_de_puntuación	número	Umbral de puntuación para la búsqueda de archivos, un número comprendido entre 0 y 1. Los números más cercanos a 1 intentarán devolver solo los resultados más relevantes, pero pueden devolver menos resultados.	No
type	enum	Tipo de la herramienta de búsqueda de archivos. Siempre file_search. Valores posibles: file_search	Sí
vector_store_ids	array	Identificadores de los almacenes vectoriales que se van a buscar.	Sí

OpenAI.FileSearchToolCallItemParam

Resultados de una llamada a la herramienta de búsqueda de archivos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
queries	array	Las consultas usadas para buscar archivos.	Sí
results	array	Resultados de la llamada a la herramienta de búsqueda de archivos.	No
type	enum	Valores posibles: file_search_call	Sí

OpenAI.FileSearchToolCallItemResource

Resultados de una llamada a la herramienta de búsqueda de archivos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
queries	array	Las consultas usadas para buscar archivos.	Sí
results	array	Resultados de la llamada a la herramienta de búsqueda de archivos.	No
estado	enum	Estado de la llamada a la herramienta de búsqueda de archivos. Uno de in_progress, searchingincomplete o failed. Valores posibles: in_progress, searching, completed, , incomplete, failed	Sí
type	enum	Valores posibles: file_search_call	Sí

OpenAI.Filters

Nombre	Tipo	Description	Obligatorio	Predeterminado
filters	array	Conjunto de filtros para combinar. Los elementos pueden ser ComparisonFilter o CompoundFilter.	Sí
key	cuerda / cadena	Clave que se va a comparar con el valor.	Sí
type	enum	Tipo de operación: and o or. Valores posibles: and, or	Sí
valor	cadena o número o booleano	Valor que se va a comparar con la clave de atributo; admite tipos de cadena, número o booleano.	Sí

OpenAI.FineTuneDPOHyperparameters

Hiperparámetros usados para el trabajo de ajuste preciso de DPO.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	enum	Valores posibles: auto	No
beta	enum	Valores posibles: auto	No
multiplicador_de_tasa_de_aprendizaje	enum	Valores posibles: auto	No
n_epochs (número de épocas)	enum	Valores posibles: auto	No

OpenAI.FineTuneDPOMethod

Configuración para el método de ajuste preciso de DPO.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.FineTuneDPOHyperparameters	Hiperparámetros usados para el trabajo de ajuste preciso de DPO.	No

OpenAI.FineTuneMethod

Método que se usa para ajustar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
dpo	OpenAI.FineTuneDPOMethod	Configuración para el método de ajuste preciso de DPO.	No
refuerzo	AzureFineTuneReinforcementMethod		No
Supervisado	OpenAI.FineTuneSupervisedMethod	Configuración del método de ajuste preciso supervisado.	No
type	enum	Tipo de método. Es supervised, dpo, o reinforcement. Valores posibles: supervised, dpo, reinforcement	Sí

OpenAI.FineTuneReinforcementHyperparameters

Los hiperparámetros usados para el trabajo de ajuste preciso de refuerzo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	enum	Valores posibles: auto	No
compute_multiplier	enum	Valores posibles: auto	No
eval_interval	enum	Valores posibles: auto	No
eval_samples	enum	Valores posibles: auto	No
multiplicador_de_tasa_de_aprendizaje	enum	Valores posibles: auto	No
n_epochs (número de épocas)	enum	Valores posibles: auto	No
esfuerzo de razonamiento	enum	Nivel de esfuerzo de razonamiento. Valores posibles: default, low, medium, high	No

OpenAI.FineTuneSupervisedHyperparameters

Hiperparámetros usados para el trabajo de ajuste preciso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño del lote	enum	Valores posibles: auto	No
multiplicador_de_tasa_de_aprendizaje	enum	Valores posibles: auto	No
n_epochs (número de épocas)	enum	Valores posibles: auto	No

OpenAI.FineTuneSupervisedMethod

Configuración del método de ajuste preciso supervisado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
hiperparámetros	OpenAI.FineTuneSupervisedHyperparameters	Hiperparámetros usados para el trabajo de ajuste preciso.	No

OpenAI.FineTuningIntegration

Discriminador para OpenAI.FineTuningIntegration

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

Valor del tipo	Schema
wandb	OpenAI.FineTuningIntegrationWandb

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	string (consulte los modelos válidos a continuación)		Sí

OpenAI.FineTuningIntegrationWandb

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de integración que se habilita para el trabajo de ajuste preciso. Valores posibles: wandb	Sí
wandb	objeto	La configuración de la integración con Weights y Biases. Esta carga especifica la project a la que se enviarán las métricas. Opcionalmente, puede establecer un nombre para mostrar explícito para la ejecución, agregar etiquetas a la ejecución y establecer una entidad predeterminada (equipo, nombre de usuario, etc.) que se asociará a la ejecución.	Sí
└─ entidad	cuerda / cadena	Entidad que se va a usar para la ejecución. Esto le permite establecer el equipo o el nombre de usuario del usuario wandB que desea asociar con la ejecución. Si no se establece, se usa la entidad predeterminada para la clave de API wandB registrada.	No
└─ Nombre	cuerda / cadena	Nombre para mostrar que se va a establecer para la ejecución. Si no se establece, usaremos el identificador de trabajo como nombre.	No
└" project	cuerda / cadena	Nombre del project en el que se creará la nueva ejecución.	No
└─ etiquetas	array	Lista de etiquetas que se van a adjuntar a la ejecución recién creada. Estas etiquetas se pasan directamente a WandB. OpenAI genera algunas etiquetas predeterminadas: "openai/finetune", "openai/{base-model}", "openai/{ftjob-abcdef}".	No

OpenAI.FineTuningJob

El objeto fine_tuning.job representa un trabajo de ajuste preciso que se ha creado a través de la API.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el trabajo de ajuste.	Sí
error	objeto	Para los trabajos de ajuste preciso que tienen failed, esto contendrá más información sobre la causa del error.	Sí
└─ código	cuerda / cadena	Código de error legible por máquina.	No
└─ Mensaje	cuerda / cadena	Mensaje de error legible.	No
└— param	cuerda / cadena	Parámetro que no era válido, normalmente training_file o validation_file. Este campo será null si el error no era específico del parámetro.	No
fin estimado	entero	Marca de tiempo de Unix (en segundos) para cuando se estima que finalizará el trabajo de ajuste. El valor será null si el trabajo de ajuste fino no se está ejecutando.	No
fine_tuned_model	cuerda / cadena	Nombre del modelo optimizado que se va a crear. El valor será null si el trabajo de ajuste se sigue ejecutando.	Sí
finished_at	entero	Marca de tiempo de Unix (en segundos) para cuando se finalizó el trabajo de ajuste. El valor será null si el trabajo de ajuste se sigue ejecutando.	Sí
hiperparámetros	objeto	Hiperparámetros usados para el trabajo de ajuste preciso. Este valor solo se devolverá cuando se ejecuten supervised trabajos.	Sí
└─ tamaño del lote (batch_size)	enum	Valores posibles: auto	No
"└─ learning_rate_multiplier"	enum	Valores posibles: auto	No
├─ n_epochs	enum	Valores posibles: auto	No
id	cuerda / cadena	Identificador de objeto, al que se puede hacer referencia en los puntos de conexión de API.	Sí
Integraciones	array	Lista de integraciones que se habilitarán para este trabajo de ajuste preciso.	No
metadata	objeto	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.	Sí
method	OpenAI.FineTuneMethod	Método que se usa para ajustar.	No
modelo	cuerda / cadena	Modelo base que se está ajustando.	Sí
objeto	enum	Tipo de objeto, que siempre es "fine_tuning.job". Valores posibles: fine_tuning.job	Sí
organization_id	cuerda / cadena	La organización que posee el trabajo de ajuste preciso.	Sí
archivos_de_resultados	array	Identificadores de archivo de resultados compilados para el trabajo de ajuste preciso. Puede recuperar los resultados con la API de los archivos.	Sí
seed	entero	Valor de inicialización utilizado para el trabajo de ajuste preciso.	Sí
estado	enum	Estado actual del trabajo de ajuste, que puede ser validating_files, queued, running, succeeded, failed o cancelled. Valores posibles: validating_files, queued, running, succeeded, , failed, cancelled	Sí
trained_tokens	entero	Número total de tokens facturables procesados por este trabajo de ajuste preciso. El valor será null si el trabajo de ajuste se sigue ejecutando.	Sí
archivo_de_entrenamiento	cuerda / cadena	Identificador de archivo usado para el entrenamiento. Puede recuperar los datos de entrenamiento con la API de archivos.	Sí
user_provided_suffix	cuerda / cadena	Sufijo descriptivo aplicado al trabajo, tal como se especifica en la solicitud de creación de trabajos.	No
archivo_de_validación	cuerda / cadena	Identificador de archivo usado para la validación. Puede recuperar los resultados de validación con la API de archivos.	Sí

OpenAI.FineTuningJobCheckpoint

El objeto fine_tuning.job.checkpoint representa un punto de comprobación de modelo para un trabajo de ajuste que está listo para usarse.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el punto de comprobación.	Sí
fine_tuned_model_checkpoint	cuerda / cadena	Nombre del modelo de punto de comprobación ajustado que se crea.	Sí
fine_tuning_job_id	cuerda / cadena	El nombre del trabajo de ajuste preciso del que se creó este punto de control.	Sí
id	cuerda / cadena	Identificador de punto de comprobación, al que se puede hacer referencia en los puntos de conexión de API.	Sí
metrics	objeto	Métricas en el número de paso durante el trabajo de ajuste preciso.	Sí
└─ full_valid_loss	número		No
└─ precisión de media de tokens válidos completos	número		No
└─ paso	número		No
└─ pérdida_entrenamiento	número		No
└─ train_mean_token_accuracy	número		No
└─ pérdida_de_validación	número		No
└" valid_mean_token_accuracy	número		No
objeto	enum	Tipo de objeto, que siempre es "fine_tuning.job.checkpoint". Valores posibles: fine_tuning.job.checkpoint	Sí
número_de_paso	entero	Número de paso en el que se creó el punto de comprobación.	Sí

OpenAI.FineTuningJobEvent

Objeto de evento de trabajo de ajuste preciso

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el trabajo de ajuste.	Sí
datos		Los datos asociados al evento.	No
id	cuerda / cadena	Identificador de objeto.	Sí
nivel	enum	Nivel de registro del evento. Valores posibles: info, warn, error	Sí
Mensaje	cuerda / cadena	Mensaje del evento.	Sí
objeto	enum	Tipo de objeto, que siempre es "fine_tuning.job.event". Valores posibles: fine_tuning.job.event	Sí
type	enum	Tipo de evento. Valores posibles: message, metrics	No

OpenAI.FunctionObject

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	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	cuerda / cadena	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		Los parámetros que aceptan las funciones, que se describen como un objeto de esquema JSON.	No
strict	booleano	Indica si se debe habilitar el cumplimiento estricto del esquema al generar la llamada a la función. Si se establece en true, el modelo seguirá el esquema exacto definido en el campo parameters. Solo se admite un subconjunto del esquema JSON cuando strict es true.	No	Falso

OpenAI.FunctionTool

Define una función en tu propio código a la que el modelo puede elegir llamar.

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	Descripción de la función. Lo usa el modelo para determinar si se debe llamar a la función o no.	No
nombre	cuerda / cadena	El nombre de la función que se va a llamar.	Sí
parameters		Objeto de esquema JSON que describe los parámetros de la función.	Sí
strict	booleano	Si se va a aplicar la validación estricta de parámetros. El valor predeterminado es true.	Sí
type	enum	Tipo de la herramienta de funciones. Siempre function. Valores posibles: function	Sí

OpenAI.FunctionToolCallItemParam

Una llamada de herramienta para ejecutar una función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Cadena JSON de los argumentos que se van a pasar a la función.	Sí
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
nombre	cuerda / cadena	Nombre de la función que se va a ejecutar.	Sí
type	enum	Valores posibles: function_call	Sí

OpenAI.FunctionToolCallItemResource

Una llamada de herramienta para ejecutar una función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Cadena JSON de los argumentos que se van a pasar a la función.	Sí
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
nombre	cuerda / cadena	Nombre de la función que se va a ejecutar.	Sí
estado	enum	Estado del elemento. Uno dein_progress, completed o incomplete. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Valores posibles: function_call	Sí

OpenAI.FunctionToolCallOutputItemParam

Salida de una llamada a la herramienta de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de función.	Sí
type	enum	Valores posibles: function_call_output	Sí

OpenAI.FunctionToolCallOutputItemResource

Salida de una llamada a la herramienta de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
call_id	cuerda / cadena	Identificador único de la llamada a la herramienta de función generada por el modelo.	Sí
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de función.	Sí
estado	enum	Estado del elemento. Uno dein_progress, completed o incomplete. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Valores posibles: function_call_output	Sí

OpenAI.Grader

Discriminador para OpenAI.Grader

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

Valor del tipo	Schema
label_model	OpenAI.GraderLabelModel
text_similarity	OpenAI.GraderTextSimilarity
python	OpenAI.GraderPython
score_model	OpenAI.GraderScoreModel
multi	OpenAI.GraderMulti

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.GraderType		Sí

OpenAI.GraderLabelModel

Objeto LabelModelGrader que usa un modelo para asignar etiquetas a cada elemento de la evaluación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	array		Sí
labels	array	Etiquetas que se van a asignar a cada elemento de la evaluación.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación. Debe admitir salidas estructuradas.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
passing_labels	array	Las etiquetas que indican un resultado aprobado. Debe ser un subconjunto de etiquetas.	Sí
type	enum	Tipo de objeto, que siempre es label_model. Valores posibles: label_model	Sí

OpenAI.GraderMulti

Un objeto MultiGrader combina la salida de varios evaluadores para generar una sola puntuación.

Nombre	Tipo	Description	Obligatorio	Predeterminado
calculate_output	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	Sí
evaluadores	objeto		Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
type	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	Sí

OpenAI.GraderPython

Objeto PythonGrader que ejecuta un script de Python en la entrada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
nombre	cuerda / cadena	Nombre del calificador.	Sí
source	cuerda / cadena	Código fuente del script de Python.	Sí
type	enum	Tipo de objeto, que siempre es python. Valores posibles: python	Sí

OpenAI.GraderScoreModel

Objeto ScoreModelGrader que usa un modelo para asignar una puntuación a la entrada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
rango	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
type	enum	Tipo de objeto, que siempre es score_model. Valores posibles: score_model	Sí

OpenAI.GraderStringCheck

Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
entrada	cuerda / cadena	Texto de entrada. Esto puede incluir cadenas de plantilla.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
operation	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	Sí
referencia	cuerda / cadena	Texto de referencia. Esto puede incluir cadenas de plantilla.	Sí
type	enum	Tipo de objeto, que siempre es string_check. Valores posibles: string_check	Sí

OpenAI.GraderTextSimilarity

Objeto TextSimilarityGrader que clasifica el texto en función de las métricas de similitud.

Nombre	Tipo	Description	Obligatorio	Predeterminado
métrica de evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Sí
entrada	cuerda / cadena	Texto que se va a calificar.	Sí
nombre	cuerda / cadena	Nombre del calificador.	Sí
referencia	cuerda / cadena	Texto con el que se va a calificar.	Sí
type	enum	Tipo de calificador. Valores posibles: text_similarity	Sí

OpenAI.GraderType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	string_check text_similarity score_model label_model python multi

OpenAI.ImageGenTool

Herramienta que genera imágenes mediante un modelo como gpt-image-1.5.

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	enum	Tipo de fondo para la imagen generada. Uno detransparent, opaque o auto. Predeterminado: auto. Valores posibles: transparent, opaque, auto	No
máscara_de_imagen_de_entrada	objeto	Máscara opcional para inpainting. Contiene image_url (cadena, opcional) y file_id (cadena, opcional).	No
└─ file_id	cuerda / cadena	Identificador de archivo de la imagen de máscara.	No
└─ image_url	cuerda / cadena	Imagen de máscara codificada en Base64.	No
modelo	enum	Modelo de generación de imágenes que se va a usar. Predeterminado: gpt-image-1. Valores posibles: gpt-image-1, gpt-image-1.5	No
moderation	enum	Nivel de moderación de la imagen generada. Predeterminado: auto. Valores posibles: auto, low	No
compresión_de_salida	entero	Nivel de compresión de la imagen de salida. Valor predeterminado: 100.	No	100
formato_de_salida	enum	Formato de salida de la imagen generada. Uno depng, webp o jpeg. Predeterminado: png. Valores posibles: png, webp, jpeg	No
imágenes_parciales	entero	Número de imágenes parciales que se van a generar en modo de streaming, de 0 (valor predeterminado) a 3.	No	0
calidad	enum	Calidad de la imagen generada. Uno de los siguientes: low, medium, high o auto. Predeterminado: auto. Valores posibles: low, medium, high, auto	No
tamaño	enum	Tamaño de la imagen generada. Uno de los siguientes: 1024x1024, 1024x1536, 1536x1024 o auto. Predeterminado: auto. Valores posibles: 1024x1024, 1024x1536, 1536x1024, auto	No
type	enum	Tipo de la herramienta de generación de imágenes. Siempre image_generation. Valores posibles: image_generation	Sí

OpenAI.ImageGenToolCallItemParam

Solicitud de generación de imágenes realizada por el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
resultado	cuerda / cadena	Imagen generada codificada en base64.	Sí
type	enum	Valores posibles: image_generation_call	Sí

OpenAI.ImageGenToolCallItemResource

Solicitud de generación de imágenes realizada por el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
resultado	cuerda / cadena	Imagen generada codificada en base64.	Sí
estado	enum	Valores posibles: in_progress, completed, generating, failed	Sí
type	enum	Valores posibles: image_generation_call	Sí

OpenAI.ImplicitUserMessage

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	cadena o matriz		Sí

OpenAI.Includable

Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Los valores admitidos actualmente son:

• code_interpreter_call.outputs: incluye las salidas de la ejecución de código de Python en los elementos de llamada de la herramienta de intérprete de código.
• computer_call_output.output.image_url: incluya direcciones URL de imagen desde la salida de la llamada del equipo.
• file_search_call.results: incluya los resultados de búsqueda de la llamada a la herramienta de búsqueda de archivos.
• message.input_image.image_url: incluya direcciones URL de imagen del mensaje de entrada.
• message.output_text.logprobs: incluya logprobs con mensajes de asistente.
• reasoning.encrypted_content: Incluye una versión cifrada de tokens de razonamiento en las salidas del elemento de razonamiento. Esto permite que los elementos de razonamiento se utilicen en conversaciones multiturno cuando se utiliza la API de Respuestas de manera sin estado (como cuando el store parámetro está configurado en false, o cuando una organización está inscrita en el programa de cero retención de datos).

Propiedad	Importancia
Descripción	Especifique datos de salida adicionales que se incluirán en la respuesta del modelo. Los valores admitidos actualmente son: - code_interpreter_call.outputs: incluye las salidas de la ejecución de código de Python en los elementos de llamada de la herramienta de intérprete de código. - computer_call_output.output.image_url: incluya direcciones URL de imagen desde la salida de la llamada del equipo. - file_search_call.results: incluya los resultados de búsqueda de la llamada a la herramienta de búsqueda de archivos. - message.input_image.image_url: incluya las URL de las imágenes del mensaje de entrada. - message.output_text.logprobs: incluya logprobs con mensajes de asistente. - reasoning.encrypted_content: incluye una versión cifrada de tokens de razonamiento en las salidas del elemento de razonamiento. Esto permite que los elementos de razonamiento se utilicen en conversaciones multiturno cuando se utiliza la API de Respuestas de manera sin estado (como cuando el store parámetro está configurado en false, o cuando una organización está inscrita en el programa de cero retención de datos).
Tipo	cuerda / cadena
Valores	code_interpreter_call.outputs computer_call_output.output.image_url file_search_call.results message.input_image.image_url message.output_text.logprobs reasoning.encrypted_content

OpenAI.ItemContent

Discriminador para OpenAI.ItemContent

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ItemContentType	Contenidos de entrada y salida multimodales.	Sí

OpenAI.ItemContentInputAudio

Entrada de audio al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	cuerda / cadena	Datos de audio codificados en Base64.	Sí
format	enum	Formato de los datos de audio. Los formatos admitidos actualmente son mp3 y wav. Valores posibles: mp3, wav	Sí
type	enum	Tipo del elemento de entrada. Siempre input_audio. Valores posibles: input_audio	Sí

OpenAI.ItemContentInputFile

Entrada de archivo para el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
file_data	cuerda / cadena	Contenido del archivo que se va a enviar al modelo.	No
ID del archivo	cuerda / cadena	Identificador del archivo que se va a enviar al modelo.	No
filename	cuerda / cadena	Nombre del archivo que se va a enviar al modelo.	No
type	enum	Tipo del elemento de entrada. Siempre input_file. Valores posibles: input_file	Sí

OpenAI.ItemContentInputImage

Entrada de imagen en el modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
detail	enum	Nivel de detalle de la imagen que se va a enviar al modelo. Uno dehigh, low o auto. Tiene como valor predeterminado auto. Valores posibles: low, high, auto	No
ID del archivo	cuerda / cadena	Identificador del archivo que se va a enviar al modelo.	No
image_url	cuerda / cadena	Dirección URL de la imagen que se va a enviar al modelo. Una URL completamente calificada o una imagen codificada en base64 en un URL de datos.	No
type	enum	Tipo del elemento de entrada. Siempre input_image. Valores posibles: input_image	Sí

OpenAI.ItemContentInputText

Entrada de texto al modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena	Entrada de texto en el modelo.	Sí
type	enum	Tipo del elemento de entrada. Siempre input_text. Valores posibles: input_text	Sí

OpenAI.ItemContentOutputAudio

Salida de audio del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	cuerda / cadena	Datos del modelo codificados en audio Base64.	Sí
transcript	cuerda / cadena	Transcripción de los datos de audio del modelo.	Sí
type	enum	Tipo del audio de salida. Siempre output_audio. Valores posibles: output_audio	Sí

OpenAI.ItemContentOutputText

Salida de texto del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
Anotaciones	array	Anotaciones de la salida de texto.	Sí
logprobs	array		No
texto	cuerda / cadena	Salida de texto del modelo.	Sí
type	enum	Tipo del texto de salida. Siempre output_text. Valores posibles: output_text	Sí

OpenAI.ItemContentRefusal

Una negativa del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
refusal	cuerda / cadena	Explicación de denegación del modelo.	Sí
type	enum	Tipo de denegación. Siempre refusal. Valores posibles: refusal	Sí

OpenAI.ItemContentType

Contenidos de entrada y salida multimodales.

Propiedad	Importancia
Descripción	Contenidos de entrada y salida multimodales.
Tipo	cuerda / cadena
Valores	input_text input_audio input_image input_file output_text output_audio refusal

OpenAI.ItemParam

Elemento de contenido usado para generar una respuesta.

Discriminador para OpenAI.ItemParam

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ItemType		Sí

OpenAI.ItemReferenceItemParam

Identificador interno de un elemento al que se va a hacer referencia.

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	cuerda / cadena	ID generado por el servicio del elemento de respuesta previamente generado al que se hace referencia.	Sí
type	enum	Valores posibles: item_reference	Sí

OpenAI.ItemResource

Elemento de contenido usado para generar una respuesta.

Discriminador para OpenAI.ItemResource

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	cuerda / cadena		Sí
type	OpenAI.ItemType		Sí

OpenAI.ItemType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	message file_search_call function_call function_call_output computer_call computer_call_output web_search_call reasoning item_reference image_generation_call code_interpreter_call local_shell_call local_shell_call_output mcp_list_tools mcp_approval_request mcp_approval_response mcp_call

OpenAI.ListFineTuningJobCheckpointsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
first_id	cuerda / cadena		No
has_more	booleano		Sí
last_id	cuerda / cadena		No
objeto	enum	Valores posibles: list	Sí

OpenAI.ListFineTuningJobEventsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
has_more	booleano		Sí
objeto	enum	Valores posibles: list	Sí

OpenAI.ListModelsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
objeto	enum	Valores posibles: list	Sí

OpenAI.ListPaginatedFineTuningJobsResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
has_more	booleano		Sí
objeto	enum	Valores posibles: list	Sí

OpenAI.ListVectorStoreFilesFilter

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	in_progress completed failed cancelled

OpenAI.ListVectorStoreFilesResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
first_id	cuerda / cadena		Sí
has_more	booleano		Sí
last_id	cuerda / cadena		Sí
objeto	enum	Valores posibles: list	Sí

OpenAI.ListVectorStoresResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array		Sí
first_id	cuerda / cadena		Sí
has_more	booleano		Sí
last_id	cuerda / cadena		Sí
objeto	enum	Valores posibles: list	Sí

OpenAI.LocalShellExecAction

Ejecute un comando de shell en el servidor.

Nombre	Tipo	Description	Obligatorio	Predeterminado
command	array	El comando que se va a ejecutar.	Sí
Entorno	objeto	Variables de entorno que se van a establecer para el comando.	Sí
tiempo_de_espera_ms	entero	Tiempo de espera opcional en milisegundos para el comando.	No
type	enum	Tipo de la acción de shell local. Siempre exec. Valores posibles: exec	Sí
user	cuerda / cadena	Usuario opcional como el cual ejecutar el comando.	No
working_directory	cuerda / cadena	Directorio de trabajo opcional en el que ejecutar el comando.	No

OpenAI.LocalShellTool

Herramienta que permite al modelo ejecutar comandos de shell en un entorno local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de la herramienta de shell local. Siempre local_shell. Valores posibles: local_shell	Sí

OpenAI.LocalShellToolCallItemParam

Una llamada de herramienta para ejecutar un comando en el shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.LocalShellExecAction	Ejecute un comando de shell en el servidor.	Sí
call_id	cuerda / cadena	Identificador único de la llamada de herramienta de shell local generada por el modelo.	Sí
type	enum	Valores posibles: local_shell_call	Sí

OpenAI.LocalShellToolCallItemResource

Una llamada de herramienta para ejecutar un comando en el shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	OpenAI.LocalShellExecAction	Ejecute un comando de shell en el servidor.	Sí
call_id	cuerda / cadena	Identificador único de la llamada de herramienta de shell local generada por el modelo.	Sí
estado	enum	Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Valores posibles: local_shell_call	Sí

OpenAI.LocalShellToolCallOutputItemParam

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de shell local.	Sí
type	enum	Valores posibles: local_shell_call_output	Sí

OpenAI.LocalShellToolCallOutputItemResource

Salida de una llamada a la herramienta de shell local.

Nombre	Tipo	Description	Obligatorio	Predeterminado
output	cuerda / cadena	Cadena JSON de la salida de la llamada a la herramienta de shell local.	Sí
estado	enum	Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Valores posibles: local_shell_call_output	Sí

OpenAI.Location

Discriminador para OpenAI.Location

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

Valor del tipo	Schema
approximate	OpenAI.ApproximateLocation

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.LocationType		Sí

OpenAI.LocationType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	approximate

OpenAI.LogProb

Probabilidad de registro de un token.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bytes	array		Sí
logprob	número		Sí
token	cuerda / cadena		Sí
top_logprobs	array		Sí

OpenAI.MCPApprovalRequestItemParam

Solicitud de aprobación humana de una invocación de herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Cadena JSON de argumentos para la herramienta.	Sí
nombre	cuerda / cadena	Nombre de la herramienta que se va a ejecutar.	Sí
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que realiza la solicitud.	Sí
type	enum	Valores posibles: mcp_approval_request	Sí

OpenAI.MCPApprovalRequestItemResource

Solicitud de aprobación humana de una invocación de herramienta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Cadena JSON de argumentos para la herramienta.	Sí
nombre	cuerda / cadena	Nombre de la herramienta que se va a ejecutar.	Sí
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que realiza la solicitud.	Sí
type	enum	Valores posibles: mcp_approval_request	Sí

OpenAI.MCPApprovalResponseItemParam

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
approval_request_id	cuerda / cadena	Identificador de la solicitud de aprobación que está siendo respondida.	Sí
aprobar	booleano	Si se aprobó la solicitud.	Sí
reason	cuerda / cadena	Motivo opcional de la decisión.	No
type	enum	Valores posibles: mcp_approval_response	Sí

OpenAI.MCPApprovalResponseItemResource

Respuesta a una solicitud de aprobación de MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
approval_request_id	cuerda / cadena	Identificador de la solicitud de aprobación que está siendo respondida.	Sí
aprobar	booleano	Si se aprobó la solicitud.	Sí
reason	cuerda / cadena	Motivo opcional de la decisión.	No
type	enum	Valores posibles: mcp_approval_response	Sí

OpenAI.MCPCallItemParam

Una invocación de una herramienta en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	cuerda / cadena	Error de la llamada a la herramienta, si existe.	No
nombre	cuerda / cadena	Nombre de la herramienta que se ejecutó.	Sí
output	cuerda / cadena	Salida de la llamada a la herramienta.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que ejecuta la herramienta.	Sí
type	enum	Valores posibles: mcp_call	Sí

OpenAI.MCPCallItemResource

Una invocación de una herramienta en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Cadena JSON de los argumentos pasados a la herramienta.	Sí
error	cuerda / cadena	Error de la llamada a la herramienta, si existe.	No
nombre	cuerda / cadena	Nombre de la herramienta que se ejecutó.	Sí
output	cuerda / cadena	Salida de la llamada a la herramienta.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que ejecuta la herramienta.	Sí
type	enum	Valores posibles: mcp_call	Sí

OpenAI.MCPListToolsItemParam

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	cuerda / cadena	Mensaje de error si el servidor no pudo enumerar las herramientas.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP.	Sí
herramientas	array	Las herramientas disponibles en el servidor.	Sí
type	enum	Valores posibles: mcp_list_tools	Sí

OpenAI.MCPListToolsItemResource

Lista de herramientas disponibles en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
error	cuerda / cadena	Mensaje de error si el servidor no pudo enumerar las herramientas.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP.	Sí
herramientas	array	Las herramientas disponibles en el servidor.	Sí
type	enum	Valores posibles: mcp_list_tools	Sí

OpenAI.MCPListToolsTool

Una herramienta disponible en un servidor MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
Anotaciones		Anotaciones adicionales sobre la herramienta.	No
descripción	cuerda / cadena	Descripción de la herramienta.	No
input_schema		Esquema JSON que describe la entrada de la herramienta.	Sí
nombre	cuerda / cadena	Nombre de la herramienta.	Sí

OpenAI.MCPTool

Asigne al modelo access herramientas adicionales a través de servidores remotos del Protocolo de contexto de modelo (MCP).

Nombre	Tipo	Description	Obligatorio	Predeterminado
herramientas_permitidas	objeto		No
└─ nombres_de_herramientas	array	Lista de nombres de herramientas permitidos.	No
headers	objeto	Encabezados HTTP opcionales para enviar al servidor MCP. Utilícelo para la autenticación u otros propósitos.	No
requerir_aprobación	object (consulte los modelos válidos a continuación)	Especifique cuál de las herramientas del servidor MCP requiere aprobación.	No
etiqueta del servidor	cuerda / cadena	Etiqueta para este servidor MCP, que se usa para identificarlo en las llamadas a herramientas.	Sí
server_url	cuerda / cadena	Dirección URL del servidor MCP.	Sí
type	enum	Tipo de la herramienta MCP. Siempre mcp. Valores posibles: mcp	Sí

OpenAI.MetadataPropertyForRequest

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.

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto	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.	No

OpenAI.Model

Describe una oferta de modelo de OpenAI que se puede usar con la API.

Nombre	Tipo	Description	Obligatorio	Predeterminado
creado	entero	Marca de tiempo de Unix (en segundos) cuando se creó el modelo.	Sí
id	cuerda / cadena	Identificador del modelo, al que se puede hacer referencia en los puntos de conexión de API.	Sí
objeto	enum	Tipo de objeto, que siempre es "modelo". Valores posibles: model	Sí
owned_by	cuerda / cadena	La organización que posee el modelo.	Sí

OpenAI.OtherChunkingStrategyResponseParam

Esto se devuelve cuando se desconoce la estrategia de fragmentación. Normalmente, esto se debe a que el archivo se indizó antes de que el concepto chunking_strategy se introdujera en la API.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Siempre other. Valores posibles: other	Sí

OpenAI.ParallelToolCalls

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

Tipo: booleano

OpenAI.Prompt

Referencia a una plantilla de solicitud y sus variables.

Nombre	Tipo	Description	Obligatorio	Predeterminado
id	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	Sí
variables	objeto	Asignación opcional de valores para sustituir por variables en la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.	No
version	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No

OpenAI.RankingOptions

Nombre	Tipo	Description	Obligatorio	Predeterminado
clasificador	enum	Clasificador que se va a usar para la búsqueda de archivos. Valores posibles: auto, default-2024-11-15	No
umbral de puntuación	número	Umbral de puntuación para la búsqueda de archivos, un número comprendido entre 0 y 1. Los números más cercanos a 1 intentarán devolver solo los resultados más relevantes, pero pueden devolver menos resultados.	No

OpenAI.Reasoning

Solo modelos de la serie o

Nombre	Tipo	Description	Obligatorio	Predeterminado
effort	objeto	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
generate_summary	enum	En desuso: use summary en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
summary	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No

OpenAI.ReasoningEffort

Solo modelos de la serie o

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

Propiedad	Importancia
Descripción	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.
Tipo	cuerda / cadena
Valores	low medium high

OpenAI.ReasoningItemParam

Descripción de la cadena de pensamiento utilizada por un modelo de razonamiento al generar una respuesta. Asegúrese de incluir estos elementos en input la API de respuestas para los turnos posteriores de una conversación si administra manualmente el contexto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
encrypted_content	cuerda / cadena	Contenido cifrado del elemento de razonamiento, rellenado cuando se genera una respuesta con reasoning.encrypted_content en el include parámetro .	No
summary	array	Contenido del texto de razonamiento.	Sí
type	enum	Valores posibles: reasoning	Sí

OpenAI.ReasoningItemResource

Descripción de la cadena de pensamiento utilizada por un modelo de razonamiento al generar una respuesta. Asegúrese de incluir estos elementos en input la API de respuestas para los turnos posteriores de una conversación si administra manualmente el contexto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
encrypted_content	cuerda / cadena	Contenido cifrado del elemento de razonamiento, rellenado cuando se genera una respuesta con reasoning.encrypted_content en el include parámetro .	No
summary	array	Contenido del texto de razonamiento.	Sí
type	enum	Valores posibles: reasoning	Sí

OpenAI.ReasoningItemSummaryPart

Discriminador para OpenAI.ReasoningItemSummaryPart

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

Valor del tipo	Schema
summary_text	OpenAI.ReasoningItemSummaryTextPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ReasoningItemSummaryPartType		Sí

OpenAI.ReasoningItemSummaryPartType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	summary_text

OpenAI.ReasoningItemSummaryTextPart

Nombre	Tipo	Description	Obligatorio	Predeterminado
texto	cuerda / cadena		Sí
type	enum	Valores posibles: summary_text	Sí

OpenAI.Response

Nombre	Tipo	Description	Obligatorio	Predeterminado
background	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	Sí
error	objeto	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	Sí
└─ código	OpenAI.ResponseErrorCode	Código de error de la respuesta.	No
└─ Mensaje	cuerda / cadena	Una descripción legible del error.	No
id	cuerda / cadena	Identificador único de esta respuesta.	Sí
incomplete_details	objeto	Detalles sobre por qué la respuesta está incompleta.	Sí
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
instructions	cadena o matriz		Sí
max_output_tokens	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
max_tool_calls	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
metadata	objeto	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.	Sí
objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	Sí
output	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	Sí
output_text	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	Sí	Cierto
previous_response_id	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
inmediato	objeto	Referencia a una plantilla de solicitud y sus variables.	No
└─ id.	cuerda / cadena	Identificador único de la plantilla de solicitud que se va a usar.	No
Variables └	OpenAI.ResponsePromptVariables	Asignación opcional de valores para sustituir por variables en la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.	No
└─ versión	cuerda / cadena	Versión opcional de la plantilla de solicitud.	No
reasoning	objeto	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ esfuerzo	OpenAI.ReasoningEffort	Solo modelos de la serie o Restringe el esfuerzo en el razonamiento de los modelos de razonamiento. Los valores admitidos actualmente son low, medium y high. Reducir el esfuerzo de razonamiento puede dar lugar a respuestas más rápidas y menos tokens usados en el razonamiento en una respuesta.	No
└─ generar_resumen	enum	En desuso: use summary en su lugar. Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
└─ resumen	enum	Resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno deauto, concise o detailed. Valores posibles: auto, concise, detailed	No
estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	Sí
texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
tool_choice	objeto	Controla la herramienta (si existe) a la que llama el modelo. 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.	No
└─ Tipo	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.	No
herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	Sí
truncation	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
usage	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
user	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	Sí

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Se genera cuando el intérprete de código transmite un fragmento de código parcial.

Nombre	Tipo	Description	Obligatorio	Predeterminado
delta	cuerda / cadena	Fragmento de código parcial que transmite el intérprete de código.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que se transmite el código.	Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call_code.delta. Valores posibles: response.code_interpreter_call_code.delta	Sí

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Se genera cuando el intérprete de código finaliza el fragmento de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Resultado del fragmento de código final por el intérprete de código.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que se finaliza el código.	Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call_code.done. Valores posibles: response.code_interpreter_call_code.done	Sí

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Se genera cuando se completa la llamada del intérprete de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que se completa la llamada del intérprete de código.	Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call.completed. Valores posibles: response.code_interpreter_call.completed	Sí

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Se genera cuando una llamada al intérprete de código está en curso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que está en curso la llamada del intérprete de código.	Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call.in_progress. Valores posibles: response.code_interpreter_call.in_progress	Sí

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Se genera cuando el intérprete de código interpreta activamente el fragmento de código.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de llamada de herramienta de intérprete de código.	Sí
output_index	entero	Índice del elemento de salida en la respuesta para la que el intérprete de código interpreta el código.	Sí
type	enum	El tipo de evento. Siempre response.code_interpreter_call.interpreting. Valores posibles: response.code_interpreter_call.interpreting	Sí

OpenAI.ResponseCompletedEvent

Se genera cuando se completa la respuesta del modelo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens (máximo de tokens de salida)	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	No
└─ salida	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
└─ top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No
type	enum	El tipo de evento. Siempre response.completed. Valores posibles: response.completed	Sí

OpenAI.ResponseContentPartAddedEvent

Se genera cuando se agrega una nueva parte de contenido.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice del elemento de contenido que se agregó.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agregó la parte de contenido.	Sí
output_index	entero	Índice del elemento de salida al que se agregó la parte de contenido.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ItemContentType	Contenidos de entrada y salida multimodales.	No
type	enum	El tipo de evento. Siempre response.content_part.added. Valores posibles: response.content_part.added	Sí

OpenAI.ResponseContentPartDoneEvent

Se emite cuando se finaliza una parte de contenido.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido que se realiza.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agregó la parte de contenido.	Sí
output_index	entero	Índice del elemento de salida al que se agregó la parte de contenido.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ItemContentType	Contenidos de entrada y salida multimodales.	No
type	enum	El tipo de evento. Siempre response.content_part.done. Valores posibles: response.content_part.done	Sí

OpenAI.ResponseCreatedEvent

Evento que se genera cuando se crea una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens (máximo de tokens de salida)	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	No
└─ salida	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores: completed, failed, in_progress, cancelled, queued o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
└─ top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No
type	enum	El tipo de evento. Siempre response.created. Valores posibles: response.created	Sí

OpenAI.ResponseError

Objeto de error devuelto cuando el modelo no puede generar una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	OpenAI.ResponseErrorCode	Código de error de la respuesta.	Sí
Mensaje	cuerda / cadena	Una descripción legible del error.	Sí

OpenAI.ResponseErrorCode

Código de error de la respuesta.

Propiedad	Importancia
Descripción	Código de error de la respuesta.
Tipo	cuerda / cadena
Valores	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

OpenAI.ResponseErrorEvent

Se genera cuando se produce un error.

Nombre	Tipo	Description	Obligatorio	Predeterminado
código	cuerda / cadena	Código de error.	Sí
Mensaje	cuerda / cadena	El mensaje de error.	Sí
param	cuerda / cadena	Parámetro de error.	Sí
type	enum	El tipo de evento. Siempre error. Valores posibles: error	Sí

OpenAI.ResponseFailedEvent

Evento que se genera cuando se produce un error en una respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens (máximo de tokens de salida)	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	No
└─ salida	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
└─ top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No
type	enum	El tipo de evento. Siempre response.failed. Valores posibles: response.failed	Sí

OpenAI.ResponseFileSearchCallCompletedEvent

Se genera cuando se completa una llamada de búsqueda de archivos (resultados encontrados).

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	entero	Índice del elemento de salida que se inicia la llamada de búsqueda de archivos.	Sí
type	enum	El tipo de evento. Siempre response.file_search_call.completed. Valores posibles: response.file_search_call.completed	Sí

OpenAI.ResponseFileSearchCallInProgressEvent

Se genera cuando se inicia una llamada de búsqueda de archivos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	entero	Índice del elemento de salida que se inicia la llamada de búsqueda de archivos.	Sí
type	enum	El tipo de evento. Siempre response.file_search_call.in_progress. Valores posibles: response.file_search_call.in_progress	Sí

OpenAI.ResponseFileSearchCallSearchingEvent

Se genera cuando una búsqueda de archivos está buscando actualmente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador del elemento de salida con el que se inicia la llamada de búsqueda de archivos.	Sí
output_index	entero	Índice del elemento de salida que la llamada de búsqueda de archivos está buscando.	Sí
type	enum	El tipo de evento. Siempre response.file_search_call.searching. Valores posibles: response.file_search_call.searching	Sí

OpenAI.ResponseFormat

Discriminador para OpenAI.ResponseFormat

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

Valor del tipo	Schema
text	OpenAI.ResponseFormatText
json_object	OpenAI.ResponseFormatJsonObject
json_schema	OpenAI.ResponseFormatJsonSchema

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

OpenAI.ResponseFormatJsonObject

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 de usuario o del sistema que lo indique to do así.

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.ResponseFormatJsonSchema

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
json_schema	objeto	Opciones de configuración de salidas estructuradas, incluido un esquema JSON.	Sí
└─ Descripción	cuerda / cadena	Descripción del formato de respuesta que usa el modelo para determinar cómo responder en el formato.	No
└─ Nombre	cuerda / cadena	Nombre del formato de respuesta. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.	No
└─ 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	Indica si se debe habilitar la adhesión estricta al esquema al generar la salida. Si se establece en true, el modelo siempre seguirá el esquema exacto definido en el campo schema. Solo se admite un subconjunto del esquema JSON cuando strict es true.	No	Falso
type	enum	Tipo de formato de respuesta que se va a definir. Siempre json_schema. Valores posibles: json_schema	Sí

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í.

Tipo: objeto

OpenAI.ResponseFormatText

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.ResponseFunctionCallArgumentsDeltaEvent

Se genera cuando hay un delta de argumentos de llamada a función parciales.

Nombre	Tipo	Description	Obligatorio	Predeterminado
delta	cuerda / cadena	Los argumentos de llamada a función delta que se agregan.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agrega el delta de argumentos de llamada de función.	Sí
output_index	entero	Índice del elemento de salida al que se agrega el delta de argumentos de llamada de función.	Sí
type	enum	El tipo de evento. Siempre response.function_call_arguments.delta. Valores posibles: response.function_call_arguments.delta	Sí

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Se genera cuando se finalizan los argumentos de llamada de función.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos	cuerda / cadena	Argumentos de llamada de función.	Sí
item_id	cuerda / cadena	Identificador del elemento.	Sí
output_index	entero	El índice del elemento de salida.	Sí
type	enum	Valores posibles: response.function_call_arguments.done	Sí

OpenAI.ResponseImageGenCallCompletedEvent

Se genera cuando se ha completado una llamada a la herramienta de generación de imágenes y la imagen final está disponible.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre 'response.image_generation_call.completed'. Valores posibles: response.image_generation_call.completed	Sí

OpenAI.ResponseImageGenCallGeneratingEvent

Se genera cuando una llamada a la herramienta de generación de imágenes genera activamente una imagen (estado intermedio).

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre "response.image_generation_call.generating". Valores posibles: response.image_generation_call.generating	Sí

OpenAI.ResponseImageGenCallInProgressEvent

Se genera cuando una llamada a la herramienta de generación de imágenes está en curso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre "response.image_generation_call.in_progress". Valores posibles: response.image_generation_call.in_progress	Sí

OpenAI.ResponseImageGenCallPartialImageEvent

Se genera cuando una imagen parcial está disponible durante el streaming de generación de imágenes.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de generación de imágenes que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
partial_image_b64	cuerda / cadena	Datos de imagen parcial codificados en Base64, adecuados para la representación como una imagen.	Sí
partial_image_index	entero	Índice basado en 0 para la imagen parcial (el back-end está basado en 1, pero se basa en 0 para el usuario).	Sí
type	enum	El tipo de evento. Siempre 'response.image_generation_call.partial_image'. Valores posibles: response.image_generation_call.partial_image	Sí

OpenAI.ResponseInProgressEvent

Se genera cuando la respuesta está en curso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens (máximo de tokens de salida)	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	No
└─ salida	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
└─ top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No
type	enum	El tipo de evento. Siempre response.in_progress. Valores posibles: response.in_progress	Sí

OpenAI.ResponseIncompleteEvent

Evento que se genera cuando una respuesta finaliza como incompleta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens (máximo de tokens de salida)	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	No
└─ salida	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
└─ top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No
type	enum	El tipo de evento. Siempre response.incomplete. Valores posibles: response.incomplete	Sí

OpenAI.ResponseItemList

Lista de elementos de respuesta.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array	Lista de elementos usados para generar esta respuesta.	Sí
first_id	cuerda / cadena	Identificador del primer elemento de la lista.	Sí
has_more	booleano	Si hay más elementos disponibles.	Sí
last_id	cuerda / cadena	Identificador del último elemento de la lista.	Sí
objeto	enum	El tipo de objeto devuelto debe ser list. Valores posibles: list	Sí

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Se genera cuando hay una diferencia (actualización parcial) a los argumentos de una llamada a la herramienta MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
delta		Actualización parcial de los argumentos para la llamada a la herramienta MCP.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre 'response.mcp_call.arguments_delta'. Valores posibles: response.mcp_call.arguments_delta	Sí

OpenAI.ResponseMCPCallArgumentsDoneEvent

Se genera cuando se finalizan los argumentos de una llamada a la herramienta MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
argumentos		Argumentos finalizados para la llamada a la herramienta MCP.	Sí
item_id	cuerda / cadena	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre 'response.mcp_call.arguments_done'. Valores posibles: response.mcp_call.arguments_done	Sí

OpenAI.ResponseMCPCallCompletedEvent

Se genera cuando una llamada a la herramienta MCP se ha completado correctamente.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	El tipo de evento. Siempre 'response.mcp_call.completed'. Valores posibles: response.mcp_call.completed	Sí

OpenAI.ResponseMCPCallFailedEvent

Se genera cuando se produce un error en una llamada a la herramienta MCP.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	El tipo de evento. Siempre "response.mcp_call.failed". Valores posibles: response.mcp_call.failed	Sí

OpenAI.ResponseMCPCallInProgressEvent

Se genera cuando una llamada a la herramienta MCP está en curso.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de llamada a la herramienta MCP que se está procesando.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre "response.mcp_call.in_progress". Valores posibles: response.mcp_call.in_progress	Sí

OpenAI.ResponseMCPListToolsCompletedEvent

Se genera cuando se ha recuperado correctamente la lista de herramientas de MCP disponibles.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	El tipo de evento. Siempre "response.mcp_list_tools.completed". Valores posibles: response.mcp_list_tools.completed	Sí

OpenAI.ResponseMCPListToolsFailedEvent

Se genera cuando se produce un error en el intento de enumerar las herramientas de MCP disponibles.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	El tipo de evento. Siempre 'response.mcp_list_tools.failed'. Valores posibles: response.mcp_list_tools.failed	Sí

OpenAI.ResponseMCPListToolsInProgressEvent

Se genera cuando el sistema está en proceso de recuperar la lista de herramientas de MCP disponibles.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	El tipo de evento. Siempre "response.mcp_list_tools.in_progress". Valores posibles: response.mcp_list_tools.in_progress	Sí

OpenAI.ResponseOutputItemAddedEvent

Se genera cuando se agrega un nuevo elemento de salida.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item	objeto	Elemento de contenido usado para generar una respuesta.	Sí
└─ id.	cuerda / cadena		No
└─ Tipo	OpenAI.ItemType		No
output_index	entero	Índice del elemento de salida que se agregó.	Sí
type	enum	El tipo de evento. Siempre response.output_item.added. Valores posibles: response.output_item.added	Sí

OpenAI.ResponseOutputItemDoneEvent

Se genera cuando un elemento de salida se marca como completado.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item	objeto	Elemento de contenido usado para generar una respuesta.	Sí
└─ id.	cuerda / cadena		No
└─ Tipo	OpenAI.ItemType		No
output_index	entero	Índice del elemento de salida que fue marcado como completado.	Sí
type	enum	El tipo de evento. Siempre response.output_item.done. Valores posibles: response.output_item.done	Sí

OpenAI.ResponsePromptVariables

Asignación opcional de valores para sustituir por variables en la solicitud. Los valores de sustitución pueden ser cadenas u otros tipos de entrada de respuesta, como imágenes o archivos.

Tipo: objeto

OpenAI.ResponseQueuedEvent

Se genera cuando se pone en cola una respuesta y se espera a que se procese.

Nombre	Tipo	Description	Obligatorio	Predeterminado
response	objeto		Sí
└─ fondo	booleano	Si se va a ejecutar la respuesta del modelo en segundo plano.	No	Falso
└─ created_at	entero	Marca de tiempo de Unix (en segundos) de cuando se creó esta respuesta.	No
└─ Error	OpenAI.ResponseError	Objeto de error devuelto cuando el modelo no puede generar una respuesta.	No
└─ id.	cuerda / cadena	Identificador único de esta respuesta.	No
└─ detalles_incompletos	objeto	Detalles sobre por qué la respuesta está incompleta.	No
└─ Motivo	enum	Motivo por el que la respuesta está incompleta. Valores posibles: max_output_tokens, content_filter	No
└─ Instrucciones	cadena o matriz	Mensaje del sistema (o desarrollador) insertado en el contexto del modelo. Al usar junto con previous_response_id, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes del sistema (o desarrollador) en nuevas respuestas.	No
└─ max_output_tokens (máximo de tokens de salida)	entero	Límite superior para el número de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento.	No
└─ «max_tool_calls»	entero	Número máximo de llamadas totales a herramientas integradas que se pueden procesar en una respuesta. Este número máximo se aplica en todas las llamadas a herramientas integradas, no por herramienta individual. Se ignorarán todos los intentos adicionales del modelo de llamar a una herramienta.	No
Metadatos └	objeto	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.	No
└─ Objeto	enum	El tipo de objeto de este recurso: siempre se establece en response. Valores posibles: response	No
└─ salida	array	Matriz de elementos de contenido generados por el modelo. - La longitud y el orden de los elementos de la output matriz dependen de la respuesta del modelo. - En lugar de acceder al primer elemento de la output matriz y suponer que es un assistant mensaje con el contenido generado por el modelo, puede considerar el uso de la output_text propiedad donde esté admitida en los SDK.	No
└─ texto_de_salida	cuerda / cadena	Propiedad de conveniencia solo para SDK, que contiene la salida de texto agregada de todos los output_text elementos de la matriz output, si hay alguno presente. Compatible con los SDK de Python y JavaScript.	No
└" parallel_tool_calls	booleano	Si se permite que el modelo ejecute llamadas de herramienta en paralelo.	No	Cierto
└─ id_de_respuesta_anterior	cuerda / cadena	Identificador único de la respuesta anterior al modelo. Úselo para crear conversaciones multiturno.	No
└─ indicación	OpenAI.Prompt	Referencia a una plantilla de solicitud y sus variables.	No
└─ razonamiento	OpenAI.Reasoning	Solo modelos de la serie o Opciones de configuración para modelos de razonamiento.	No
└─ estado	enum	Estado de la generación de respuesta. Uno de estos valores completed, failed, in_progress, cancelled, queued, o incomplete. Valores posibles: completed, failed, in_progress, cancelled, , queued, incomplete	No
└─ Temperatura	número	Temperatura de muestreo que se vaya a usar, entre 0 y 2. Los valores más altos, como 0,8, harán que la salida sea más aleatoria, mientras que los valores más bajos, como 0,2, la harán más enfocada y determinista. Por lo general, recomendamos modificar esto o top_p, pero no ambos.	No
└─ texto	objeto	Opciones de configuración para una respuesta de texto del modelo. Puede ser texto sin formato o datos JSON estructurados.	No
└─ Formato	OpenAI.ResponseTextFormatConfiguration		No
└─ selección_de_herramienta	OpenAI.ToolChoiceOptions o OpenAI.ToolChoiceObject	Cómo debe seleccionar el modelo qué herramienta (o herramientas) se van a usar al generar una respuesta. Consulte el tools parámetro para ver cómo especificar las herramientas a las que puede llamar el modelo.	No
└─ herramientas	array	Una matriz de herramientas que el modelo puede llamar al generar una respuesta. Puede especificar qué herramienta usar estableciendo el tool_choice parámetro . Las dos categorías de herramientas que puede proporcionar al modelo son: - Herramientas integradas: herramientas proporcionadas por OpenAI que amplían las funcionalidades del modelo.	No
└" top_logprobs	entero	Entero entre 0 y 20 que especifica el número de tokens más probables que se devolverán en cada posición del token, cada uno con una probabilidad de registro asociada.	No
└─ top_p	número	Una alternativa al muestreo con temperatura, llamada muestreo de núcleo, donde el modelo considera los resultados de los tokens con masa de probabilidad top_p. Así, 0,1 significa que solo se consideran los tokens que comprenden la masa de probabilidad del 10% superior. Por lo general, recomendamos modificar esto o temperature, pero no ambos.	No
└─ truncamiento	enum	Estrategia de truncamiento que se va a usar para la respuesta del modelo. - auto: si el contexto de esta respuesta y los anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarse a la ventana de contexto quitando los elementos de entrada en medio de la conversación. - disabled (valor predeterminado): si una respuesta del modelo superará el tamaño de la ventana de contexto de un modelo, se producirá un error 400 en la solicitud. Valores posibles: auto, disabled	No
└─ uso	OpenAI.ResponseUsage	Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.	No
└─ Usuario	cuerda / cadena	Identificador único que representa al usuario final, que puede ayudar a OpenAI a supervisar y detectar abusos.	No
type	enum	El tipo de evento. Siempre 'response.queued'. Valores posibles: response.queued	Sí

OpenAI.ResponseReasoningDeltaEvent

Se genera cuando hay una diferencia (actualización parcial) al contenido de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido de razonamiento dentro del elemento de salida.	Sí
delta		Actualización parcial del contenido de razonamiento.	Sí
item_id	cuerda / cadena	Identificador único del elemento para el que se actualiza el razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
type	enum	El tipo de evento. Siempre 'response.reasoning.delta'. Valores posibles: response.reasoning.delta	Sí

OpenAI.ResponseReasoningDoneEvent

Se emite cuando el contenido de razonamiento se completa para un ítem.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido de razonamiento dentro del elemento de salida.	Sí
item_id	cuerda / cadena	Identificador único del elemento para el que se finaliza el razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
texto	cuerda / cadena	Texto de razonamiento finalizado.	Sí
type	enum	El tipo de evento. La entrada siempre es 'response.reasoning.done'. Valores posibles: response.reasoning.done	Sí

OpenAI.ResponseReasoningSummaryDeltaEvent

Se genera cuando hay una diferencia (actualización parcial) al contenido de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
delta		Actualización parcial del contenido del resumen del razonamiento.	Sí
item_id	cuerda / cadena	Identificador único del elemento para el que se actualiza el resumen de razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
summary_index	entero	Índice del elemento de resumen dentro del elemento de salida.	Sí
type	enum	El tipo de evento. Siempre 'response.reasoning_summary.delta'. Valores posibles: response.reasoning_summary.delta	Sí

OpenAI.ResponseReasoningSummaryDoneEvent

Se genera cuando el contenido de resumen de razonamiento se finaliza para un elemento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento para el que se finaliza el resumen de razonamiento.	Sí
output_index	entero	Índice del elemento de salida de la matriz de salida de la respuesta.	Sí
summary_index	entero	Índice del elemento de resumen dentro del elemento de salida.	Sí
texto	cuerda / cadena	Texto de resumen de razonamiento finalizado.	Sí
type	enum	El tipo de evento. Siempre 'response.reasoning_summary.done'. Valores posibles: response.reasoning_summary.done	Sí

OpenAI.ResponseReasoningSummaryPartAddedEvent

Se genera cuando se agrega una nueva parte de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado esta parte de resumen.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ReasoningItemSummaryPartType		No
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_part.added. Valores posibles: response.reasoning_summary_part.added	Sí

OpenAI.ResponseReasoningSummaryPartDoneEvent

Se emite cuando se completa una parte del resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	El identificador del elemento al que está asociado este elemento de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado esta parte de resumen.	Sí
part	objeto		Sí
└─ Tipo	OpenAI.ReasoningItemSummaryPartType		No
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_part.done. Valores posibles: response.reasoning_summary_part.done	Sí

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Se genera cuando se agrega un delta a un texto de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
delta	cuerda / cadena	Delta de texto que se agregó al resumen.	Sí
item_id	cuerda / cadena	El identificador del elemento al que está asociado este delta de texto de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado este delta de texto de resumen.	Sí
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_text.delta. Valores posibles: response.reasoning_summary_text.delta	Sí

OpenAI.ResponseReasoningSummaryTextDoneEvent

Se genera cuando se completa un texto de resumen de razonamiento.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	El identificador del elemento al que está asociado este texto de resumen.	Sí
output_index	entero	Índice del elemento de salida al que está asociado este texto de resumen.	Sí
summary_index	entero	Índice de la parte de resumen dentro del resumen de razonamiento.	Sí
texto	cuerda / cadena	Texto completo del resumen de razonamiento completado.	Sí
type	enum	El tipo de evento. Siempre response.reasoning_summary_text.done. Valores posibles: response.reasoning_summary_text.done	Sí

OpenAI.ResponseRefusalDeltaEvent

Se emite cuando hay un texto de denegación parcial.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido a la que se agrega el texto de denegación.	Sí
delta	cuerda / cadena	Texto de denegación que se agrega.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agrega el texto de denegación.	Sí
output_index	entero	Índice del elemento de salida al que se agrega el texto de denegación.	Sí
type	enum	El tipo de evento. Siempre response.refusal.delta. Valores posibles: response.refusal.delta	Sí

OpenAI.ResponseRefusalDoneEvent

Se emite cuando se finaliza el texto de rechazo.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido en la que se finaliza el texto de denegación.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida que finaliza el texto de denegación.	Sí
output_index	entero	Índice del elemento de salida que finaliza el texto de denegación.	Sí
refusal	cuerda / cadena	Texto de denegación finalizado.	Sí
type	enum	El tipo de evento. Siempre response.refusal.done. Valores posibles: response.refusal.done	Sí

OpenAI.ResponseStreamEvent

Discriminador para OpenAI.ResponseStreamEvent

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
sequence_number	entero	Número de secuencia de este evento.	Sí
type	OpenAI.ResponseStreamEventType		Sí

OpenAI.ResponseStreamEventType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	response.audio.delta response.audio.done response.audio_transcript.delta response.audio_transcript.done response.code_interpreter_call_code.delta response.code_interpreter_call_code.done response.code_interpreter_call.completed response.code_interpreter_call.in_progress response.code_interpreter_call.interpreting response.completed response.content_part.added response.content_part.done response.created error response.file_search_call.completed response.file_search_call.in_progress response.file_search_call.searching response.function_call_arguments.delta response.function_call_arguments.done response.in_progress response.failed response.incomplete response.output_item.added response.output_item.done response.refusal.delta response.refusal.done response.output_text.annotation.added response.output_text.delta response.output_text.done response.reasoning_summary_part.added response.reasoning_summary_part.done response.reasoning_summary_text.delta response.reasoning_summary_text.done response.web_search_call.completed response.web_search_call.in_progress response.web_search_call.searching response.image_generation_call.completed response.image_generation_call.generating response.image_generation_call.in_progress response.image_generation_call.partial_image response.mcp_call.arguments_delta response.mcp_call.arguments_done response.mcp_call.completed response.mcp_call.failed response.mcp_call.in_progress response.mcp_list_tools.completed response.mcp_list_tools.failed response.mcp_list_tools.in_progress response.queued response.reasoning.delta response.reasoning.done response.reasoning_summary.delta response.reasoning_summary.done

OpenAI.ResponseTextDeltaEvent

Se genera cuando hay un delta de texto adicional.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido a la que se agregó el delta de texto.	Sí
delta	cuerda / cadena	Delta de texto que se agregó.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida al que se agregó el delta de texto.	Sí
output_index	entero	Índice del elemento de salida al que se agregó el delta de texto.	Sí
type	enum	El tipo de evento. Siempre response.output_text.delta. Valores posibles: response.output_text.delta	Sí

OpenAI.ResponseTextDoneEvent

Se genera cuando se finaliza el contenido de texto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
content_index	entero	Índice de la parte de contenido que finaliza el contenido de texto.	Sí
item_id	cuerda / cadena	Identificador del elemento de salida que finaliza el contenido del texto.	Sí
output_index	entero	Índice del elemento de salida que finaliza el contenido del texto.	Sí
texto	cuerda / cadena	Contenido de texto finalizado.	Sí
type	enum	El tipo de evento. Siempre response.output_text.done. Valores posibles: response.output_text.done	Sí

OpenAI.ResponseTextFormatConfiguration

Discriminador para OpenAI.ResponseTextFormatConfiguration

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

Valor del tipo	Schema
text	OpenAI.ResponseTextFormatConfigurationText
json_object	OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema	OpenAI.ResponseTextFormatConfigurationJsonSchema

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ResponseTextFormatConfigurationType	Objeto que especifica el formato que debe generar el modelo. { "type": "json_schema" } La configuración habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado. El formato predeterminado es { "type": "text" } sin opciones adicionales. No se recomienda para los modelos gpt-4o y más recientes: 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.	Sí

OpenAI.ResponseTextFormatConfigurationJsonObject

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

OpenAI.ResponseTextFormatConfigurationJsonSchema

Formato de respuesta del esquema JSON. Se usa para generar respuestas JSON estructuradas.

Nombre	Tipo	Description	Obligatorio	Predeterminado
descripción	cuerda / cadena	Descripción del formato de respuesta que usa el modelo para determinar cómo responder en el formato.	No
nombre	cuerda / cadena	Nombre del formato de respuesta. Debe ser a-z, A-Z, 0-9, o contener caracteres de subrayado y guiones, con una longitud máxima de 64.	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í.	Sí
strict	booleano	Indica si se debe habilitar la adhesión estricta al esquema al generar la salida. Si se establece en true, el modelo siempre seguirá el esquema exacto definido en el campo schema. Solo se admite un subconjunto del esquema JSON cuando strict es true.	No	Falso
type	enum	Tipo de formato de respuesta que se va a definir. Siempre json_schema. Valores posibles: json_schema	Sí

OpenAI.ResponseTextFormatConfigurationText

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

OpenAI.ResponseTextFormatConfigurationType

Objeto que especifica el formato que debe generar el modelo.

{ "type": "json_schema" } La configuración habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado.

El formato predeterminado es { "type": "text" } sin opciones adicionales.

No se recomienda para los modelos gpt-4o y más recientes:

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.

Propiedad	Importancia
Descripción	Objeto que especifica el formato que debe generar el modelo.

{ "type": "json_schema" } La configuración habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON proporcionado.

El formato predeterminado es { "type": "text" } sin opciones adicionales.

No se recomienda para los modelos gpt-4o y más recientes:

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.

OpenAI.ResponseUsage

Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados.

Nombre	Tipo	Description	Obligatorio	Predeterminado
input_tokens	entero	Número de tokens de entrada.	Sí
input_tokens_details	objeto	Desglose detallado de los tokens de entrada.	Sí
└─ tokens en caché	entero	Número de tokens que se recuperaron de la memoria caché.	No
output_tokens	entero	Número de tokens de salida.	Sí
output_tokens_details	objeto	Desglose detallado de los tokens de salida.	Sí
─ reasoning_tokens	entero	Número de elementos de razonamiento.	No
total_tokens	entero	Número total de tokens usados.	Sí

OpenAI.ResponseWebSearchCallCompletedEvent

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	entero	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
type	enum	El tipo de evento. Siempre response.web_search_call.completed. Valores posibles: response.web_search_call.completed	Sí

OpenAI.ResponseWebSearchCallInProgressEvent

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	entero	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
type	enum	El tipo de evento. Siempre response.web_search_call.in_progress. Valores posibles: response.web_search_call.in_progress	Sí

OpenAI.ResponseWebSearchCallSearchingEvent

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
item_id	cuerda / cadena	Identificador único del elemento de salida asociado a la llamada de búsqueda web.	Sí
output_index	entero	Índice del elemento de salida al que está asociada la llamada de búsqueda web.	Sí
type	enum	El tipo de evento. Siempre response.web_search_call.searching. Valores posibles: response.web_search_call.searching	Sí

OpenAI.ResponsesAssistantMessageItemParam

Un elemento de parámetro de mensaje con el rol assistant.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre assistant. Valores posibles: assistant	Sí

OpenAI.ResponsesAssistantMessageItemResource

Un elemento de recurso de mensaje con el rol assistant.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre assistant. Valores posibles: assistant	Sí

OpenAI.ResponsesDeveloperMessageItemParam

Un elemento de parámetro de mensaje con el rol developer.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre developer. Valores posibles: developer	Sí

OpenAI.ResponsesDeveloperMessageItemResource

Un elemento de recurso de mensaje con el rol developer.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre developer. Valores posibles: developer	Sí

OpenAI.ResponsesMessageItemParam

Elemento de mensaje de respuesta, que representa un rol y contenido, proporcionado como parámetros de solicitud del cliente.

Discriminador para OpenAI.ResponsesMessageItemParam

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

Valor del tipo	Schema
user	OpenAI.ResponsesUserMessageItemParam
system	OpenAI.ResponsesSystemMessageItemParam
developer	OpenAI.ResponsesDeveloperMessageItemParam
assistant	OpenAI.ResponsesAssistantMessageItemParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
role	objeto	Colección de roles válidos para los elementos de mensaje de respuestas.	Sí
type	enum	Tipo del elemento de respuestas, que siempre es "message". Valores posibles: message	Sí

OpenAI.ResponsesMessageItemResource

Un elemento de recurso de mensaje de respuesta, que representa un rol y contenido, tal como se proporciona en las respuestas de servicio.

Discriminador para OpenAI.ResponsesMessageItemResource

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

Valor del tipo	Schema
user	OpenAI.ResponsesUserMessageItemResource
system	OpenAI.ResponsesSystemMessageItemResource
developer	OpenAI.ResponsesDeveloperMessageItemResource
assistant	OpenAI.ResponsesAssistantMessageItemResource

Nombre	Tipo	Description	Obligatorio	Predeterminado
role	objeto	Colección de roles válidos para los elementos de mensaje de respuestas.	Sí
estado	enum	Estado del elemento. Uno dein_progress, completed o incomplete. Se rellena cuando los elementos se devuelven a través de la API. Valores posibles: in_progress, completed, incomplete	Sí
type	enum	Tipo del elemento de respuestas, que siempre es "message". Valores posibles: message	Sí

OpenAI.ResponsesMessageRole

Colección de roles válidos para los elementos de mensaje de respuestas.

Propiedad	Importancia
Descripción	Colección de roles válidos para los elementos de mensaje de respuestas.
Tipo	cuerda / cadena
Valores	system developer user assistant

OpenAI.ResponsesSystemMessageItemParam

Un elemento de parámetro de mensaje con el rol system.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre system. Valores posibles: system	Sí

OpenAI.ResponsesSystemMessageItemResource

Un elemento de recurso de mensaje con el rol system.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre system. Valores posibles: system	Sí

OpenAI.ResponsesUserMessageItemParam

Un elemento de parámetro de mensaje con el rol user.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre user. Valores posibles: user	Sí

OpenAI.ResponsesUserMessageItemResource

Un elemento de recurso de mensaje con el rol user.

Nombre	Tipo	Description	Obligatorio	Predeterminado
contenido	array	Contenido asociado al mensaje.	Sí
role	enum	El papel del mensaje, que siempre user. Valores posibles: user	Sí

OpenAI.RunGraderRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	No
└─ evaluadores	objeto		No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	No
item		Elemento de conjunto de datos proporcionado al evaluador. Se usará para rellenar el item espacio de nombres.	No
model_sample	cuerda / cadena	Ejemplo de modelo que se va a evaluar. Este valor se usará para rellenar el sample espacio de nombres. La output_json variable se rellenará si el ejemplo de modelo es una cadena JSON válida.	Sí

OpenAI.RunGraderResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
metadata	objeto		Sí
└─ errores	objeto		No
└─ error_de_análisis_de_fórmula	booleano		No
└" invalid_variable_error	booleano		No
└─ error_de_análisis_del_calificador_de_modelo	booleano		No
└─ error_de_rechazo_del_calificador_de_modelo	booleano		No
└" model_grader_server_error	booleano		No
└─ detalles_de_error_del_servidor_del_calificador_de_modelos	cuerda / cadena		No
└" other_error	booleano		No
└" python_grader_runtime_error	booleano		No
└─ detalles_de_error_de_ejecución_de_python_grader	cuerda / cadena		No
├─ python_grader_server_error	booleano		No
└" python_grader_server_error_type	cuerda / cadena		No
└─ error_de_análisis_de_muestra	booleano		No
└─ error_de_observación_truncada	booleano		No
└─ error_de_recompensa_no_responsiva	booleano		No
└" execution_time	número		No
└─ Nombre	cuerda / cadena		No
└" sampled_model_name	cuerda / cadena		No
└— puntuaciones			No
└─ uso_de_token	entero		No
└─ Tipo	cuerda / cadena		No
model_grader_token_usage_per_model			Sí
recompensa	número		Sí
sub_rewards			Sí

OpenAI.StaticChunkingStrategy

Nombre	Tipo	Description	Obligatorio	Predeterminado
chunk_overlap_tokens	entero	Número de tokens que se superponen entre fragmentos. El valor predeterminado es 400. Tenga en cuenta que la superposición no debe superar la mitad de max_chunk_size_tokens.	Sí
max_chunk_size_tokens	entero	Número máximo de tokens en cada fragmento. El valor predeterminado es 800. El valor mínimo es 100 y el valor máximo es 4096.	Sí

OpenAI.StaticChunkingStrategyRequestParam

Personalice su propia estrategia de fragmentación estableciendo el tamaño del fragmento y la superposición de fragmentos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
estático	OpenAI.StaticChunkingStrategy		Sí
type	enum	Siempre static. Valores posibles: static	Sí

OpenAI.StaticChunkingStrategyResponseParam

Nombre	Tipo	Description	Obligatorio	Predeterminado
estático	OpenAI.StaticChunkingStrategy		Sí
type	enum	Siempre static. Valores posibles: static	Sí

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:

• cadena
• array

OpenAI.Tool

Discriminador para OpenAI.Tool

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ToolType	Herramienta que se puede usar para generar una respuesta.	Sí

OpenAI.ToolChoiceObject

Discriminador para OpenAI.ToolChoiceObject

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

Valor del tipo	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

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.ToolChoiceObjectType	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.	Sí

OpenAI.ToolChoiceObjectCodeInterpreter

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

OpenAI.ToolChoiceObjectComputer

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

OpenAI.ToolChoiceObjectFileSearch

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

OpenAI.ToolChoiceObjectFunction

Use esta opción para forzar al modelo a llamar a una función específica.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	cuerda / cadena	El nombre de la función que se va a llamar.	Sí
type	enum	En el caso de las llamadas a funciones, el tipo siempre es function. Valores posibles: function	Sí

OpenAI.ToolChoiceObjectImageGen

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

OpenAI.ToolChoiceObjectMCP

Use esta opción para forzar al modelo a llamar a una herramienta específica en un servidor MCP remoto.

Nombre	Tipo	Description	Obligatorio	Predeterminado
nombre	cuerda / cadena	Nombre de la herramienta que se va a llamar en el servidor.	No
etiqueta del servidor	cuerda / cadena	Etiqueta del servidor MCP que se va a usar.	Sí
type	enum	En el caso de las herramientas MCP, el tipo siempre es mcp. Valores posibles: mcp	Sí

OpenAI.ToolChoiceObjectType

Indica que el modelo debe usar una herramienta integrada para generar una respuesta.

Propiedad	Importancia
Descripción	Indica que el modelo debe usar una herramienta integrada para generar una respuesta.
Tipo	cuerda / cadena
Valores	file_search function computer_use_preview web_search_preview image_generation code_interpreter mcp

OpenAI.ToolChoiceObjectWebSearch

Nota: web_search aún no está disponible a través de Azure OpenAI.

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

OpenAI.ToolChoiceOptions

Controla la herramienta (si existe) a la que llama el modelo.

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.

Propiedad	Importancia
Descripción	Controla la herramienta (si existe) a la que llama el modelo. 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.
Tipo	cuerda / cadena
Valores	none auto required

OpenAI.ToolType

Herramienta que se puede usar para generar una respuesta.

Propiedad	Importancia
Descripción	Herramienta que se puede usar para generar una respuesta.
Tipo	cuerda / cadena
Valores	file_search function computer_use_preview web_search_preview mcp code_interpreter image_generation local_shell

OpenAI.TopLogProb

La probabilidad de registro superior de un token.

Nombre	Tipo	Description	Obligatorio	Predeterminado
bytes	array		Sí
logprob	número		Sí
token	cuerda / cadena		Sí

OpenAI.TranscriptionAudioResponseFormat

Referencias: OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	logprobs

OpenAI.TranscriptionSegment

Nombre	Tipo	Description	Obligatorio	Predeterminado
avg_logprob	número	Promedio de logprob del segmento. Si el valor es inferior a -1, considere fallidos los logprobs.	Sí
compression_ratio	número	Relación de compresión del segmento. Si el valor es mayor que 2.4, considere el error de compresión.	Sí
fin	número	Hora de finalización del segmento en segundos.	Sí
id	entero	Identificador único del segmento.	Sí
no_speech_prob	número	Probabilidad de que no haya voz en el segmento. Si el valor es mayor que 1.0 y avg_logprob está por debajo de -1, considere este segmento silencioso.	Sí
seek	entero	Buscar desplazamiento del segmento.	Sí
inicio	número	Hora de inicio del segmento en segundos.	Sí
temperatura	número	Parámetro de temperatura usado para generar el segmento.	Sí
texto	cuerda / cadena	Contenido de texto del segmento.	Sí
tokens	array	Matriz de identificadores de token para el contenido de texto.	Sí

OpenAI.TranscriptionWord

Nombre	Tipo	Description	Obligatorio	Predeterminado
fin	número	Hora de finalización de la palabra en segundos.	Sí
inicio	número	Hora de inicio de la palabra en segundos.	Sí
word	cuerda / cadena	Contenido de texto de la palabra.	Sí

OpenAI.TranslationAudioResponseFormat

Referencias: OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	Sí

OpenAI.UpdateVectorStoreRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
expires_after	objeto	Directiva de expiración de un almacén de vectores.	No
└─ delimitador	enum	Marca de tiempo de anclaje después de la cual se aplica la directiva de expiración. Anclajes admitidos: last_active_at. Valores posibles: last_active_at	No
└─ días	entero	Número de días después del tiempo de delimitador que expirará el almacén de vectores.	No
metadata	objeto	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.	No
nombre	cuerda / cadena	Nombre del almacén de vectores.	No

OpenAI.VadConfig

Nombre	Tipo	Description	Obligatorio	Predeterminado
prefix_padding_ms	entero	Cantidad de audio que se va a incluir antes de que el VAD detecte voz (en milisegundos).	No	300
silence_duration_ms	entero	Duración del silencio para detectar la detención de voz (en milisegundos). Con valores más cortos, el modelo responderá más rápidamente, pero puede saltar en pausas cortas del usuario.	No	200
threshold	número	Umbral de sensibilidad (de 0,0 a 1,0) para la detección de actividad de voz. Un umbral superior requerirá audio más alto para activar el modelo y, por tanto, podría funcionar mejor en entornos ruidosos.	No	0,5
type	enum	Debe establecerse en server_vad para habilitar la fragmentación manual mediante VAD del lado servidor. Valores posibles: server_vad	Sí

OpenAI.ValidateGraderRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	Sí
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	No
└─ evaluadores	objeto		No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	No

OpenAI.ValidateGraderResponse

Nombre	Tipo	Description	Obligatorio	Predeterminado
evaluador	objeto	Objeto StringCheckGrader que realiza una comparación de cadenas entre la entrada y la referencia mediante una operación especificada.	No
└─ calcular_salida	cuerda / cadena	Fórmula para calcular la salida en función de los resultados del evaluador.	No
└─ métrica_de_evaluación	enum	Métrica de evaluación que se va a usar. Uno de fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5 o rouge_l. Valores posibles: fuzzy_match, bleu, , gleu, meteorrouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	No
└─ evaluadores	objeto		No
└" image_tag	cuerda / cadena	Etiqueta de imagen que se va a usar para el script de Python.	No
└─ Entrada	array	Texto de entrada. Esto puede incluir cadenas de plantilla.	No
└─ modelo	cuerda / cadena	Modelo que se va a usar para la evaluación.	No
└─ Nombre	cuerda / cadena	Nombre del calificador.	No
└─ operación	enum	Operación de comprobación de cadena que se va a realizar. Uno de los siguientes: eq, ne, like o ilike. Valores posibles: eq, ne, like, ilike	No
└─ intervalo	array	El rango de la puntuación. Tiene como valor predeterminado [0, 1].	No
└─ referencia	cuerda / cadena	Texto con el que se va a calificar.	No
└─ parámetros_de_muestreo		Parámetros de muestreo para el modelo.	No
└─ Origen	cuerda / cadena	Código fuente del script de Python.	No
└─ Tipo	enum	Tipo de objeto, que siempre es multi. Valores posibles: multi	No

OpenAI.VectorStoreExpirationAfter

Directiva de expiración de un almacén de vectores.

Nombre	Tipo	Description	Obligatorio	Predeterminado
anchor	enum	Marca de tiempo de anclaje después de la cual se aplica la directiva de expiración. Anclajes admitidos: last_active_at. Valores posibles: last_active_at	Sí
Días	entero	Número de días después del tiempo de delimitador que expirará el almacén de vectores.	Sí

OpenAI.VectorStoreFileAttributes

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, booleanos o números.

Tipo: objeto

OpenAI.VectorStoreFileBatchObject

Un lote de archivos adjuntos a un almacén de vectores.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el lote de archivos de almacén de vectores.	Sí
file_counts	objeto		Sí
└' cancelado	entero	Número de archivos en los que se canceló.	No
└— completado	entero	Número de archivos que se han procesado.	No
└─ fallido	entero	Número de archivos que no se han podido procesar.	No
└─ en_progreso	entero	Número de archivos que se están procesando actualmente.	No
└─ total	entero	Número total de archivos.	No
id	cuerda / cadena	Identificador al que se puede hacer referencia en puntos de conexión de API.	Sí
objeto	enum	Tipo de objeto, que siempre es vector_store.file_batch. Valores posibles: vector_store.files_batch	Sí
estado	enum	Estado del lote de archivos de almacenamiento vectorial, que puede ser in_progress, completedcancelled o failed. Valores posibles: in_progress, completed, cancelled, failed	Sí
vector_store_id	cuerda / cadena	Identificador del almacén de vectores al que está asociado el archivo.	Sí

OpenAI.VectorStoreFileObject

Lista de archivos adjuntos a un almacén de vectores.

Nombre	Tipo	Description	Obligatorio	Predeterminado
attributes	objeto	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, booleanos o números.	No
chunking_strategy	objeto		No
└─ Tipo	enum	Valores posibles: static, other	No
fecha_de_creación	entero	La marca de tiempo Unix (en segundos) de cuando se creó el archivo del almacén vectorial.	Sí
id	cuerda / cadena	Identificador al que se puede hacer referencia en puntos de conexión de API.	Sí
last_error	objeto	El último error asociado a este archivo de almacén de vectores. Será null si no hay errores.	Sí
└─ código	enum	Uno de estos valores: server_error o rate_limit_exceeded. Valores posibles: server_error, unsupported_file, invalid_file	No
└─ Mensaje	cuerda / cadena	Una descripción legible del error.	No
objeto	enum	Tipo de objeto, que siempre es vector_store.file. Valores posibles: vector_store.file	Sí
estado	enum	Estado del archivo de almacén de vectores, que puede ser in_progress, completed, cancelled o failed. El estado completed indica que el archivo de almacén de vectores está listo para su uso. Valores posibles: in_progress, completed, cancelled, failed	Sí
usage_bytes	entero	El uso total del almacén de vectores en bytes. Tenga en cuenta que este puede ser distinto del tamaño del archivo original.	Sí
vector_store_id	cuerda / cadena	Identificador del almacén de vectores al que está asociado el archivo.	Sí

OpenAI.VectorStoreObject

Un almacén vectorial es una colección de archivos procesados que pueden ser usados por la herramienta file_search.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Marca de tiempo de Unix (en segundos) para cuando se creó el archivo de mensaje.	Sí
expires_after	OpenAI.VectorStoreExpirationAfter	Directiva de expiración de un almacén de vectores.	No
expires_at	entero	Marca de tiempo de Unix (en segundos) para cuando expire el almacén de vectores.	No
file_counts	objeto		Sí
└' cancelado	entero	Número de archivos cancelados.	No
└— completado	entero	Número de archivos que se han procesado correctamente.	No
└─ fallido	entero	Número de archivos que no se han podido procesar.	No
└─ en_progreso	entero	Número de archivos que se están procesando actualmente.	No
└─ total	entero	Número total de archivos.	No
id	cuerda / cadena	Identificador al que se puede hacer referencia en puntos de conexión de API.	Sí
última_actividad_en	entero	Marca de tiempo de Unix (en segundos) para cuando el almacén de vectores estaba activo por última vez.	Sí
metadata	objeto	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.	Sí
nombre	cuerda / cadena	Nombre del almacén de vectores.	Sí
objeto	enum	Tipo de objeto, que siempre es vector_store. Valores posibles: vector_store	Sí
estado	enum	Estado del almacén de vectores, que puede ser expired, in_progress o completed. Un estado de completed indica que el almacén de vectores está listo para su uso. Valores posibles: expired, in_progress, completed	Sí
usage_bytes	entero	Número total de bytes usados por los archivos en el almacén de vectores.	Sí

OpenAI.VoiceIdsShared

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	alloy ash ballad coral echo fable onyx nova sage shimmer verse

OpenAI.WebSearchAction

Discriminador para OpenAI.WebSearchAction

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

Valor del tipo	Schema
find	OpenAI.WebSearchActionFind
open_page	OpenAI.WebSearchActionOpenPage
search	OpenAI.WebSearchActionSearch

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	OpenAI.WebSearchActionType		Sí

OpenAI.WebSearchActionFind

Tipo de acción "buscar": busca un patrón dentro de una página cargada.

Nombre	Tipo	Description	Obligatorio	Predeterminado
pattern	cuerda / cadena	Patrón o texto que se va a buscar en la página.	Sí
type	enum	Tipo de acción. Valores posibles: find	Sí
URL	cuerda / cadena	Dirección URL de la página en la que se busca el patrón.	Sí

OpenAI.WebSearchActionOpenPage

Tipo de acción "open_page": abre una dirección URL específica de los resultados de la búsqueda.

Nombre	Tipo	Description	Obligatorio	Predeterminado
type	enum	Tipo de acción. Valores posibles: open_page	Sí
URL	cuerda / cadena	Dirección URL abierta por el modelo.	Sí

OpenAI.WebSearchActionSearch

Tipo de acción "search": realiza una consulta de búsqueda web.

Nombre	Tipo	Description	Obligatorio	Predeterminado
query	cuerda / cadena	Consulta de la búsqueda.	Sí
type	enum	Tipo de acción. Valores posibles: search	Sí

OpenAI.WebSearchActionType

Propiedad	Importancia
Tipo	cuerda / cadena
Valores	search open_page find

OpenAI.WebSearchPreviewTool

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
tamaño_del_contexto_de_búsqueda	enum	Orientación general sobre la cantidad de espacio de ventana de contexto que se va a usar para la búsqueda. Uno delow, medium o high. medium es el valor predeterminado. Valores posibles: low, medium, high	No
type	enum	Tipo de la herramienta de búsqueda web. Uno de estos valores: web_search_preview o web_search_preview_2025_03_11. Valores posibles: web_search_preview	Sí
ubicación_del_usuario	objeto		No
└─ Tipo	OpenAI.LocationType		No

OpenAI.WebSearchToolCallItemParam

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	objeto		Sí
└─ Tipo	OpenAI.WebSearchActionType		No
type	enum	Valores posibles: web_search_call	Sí

OpenAI.WebSearchToolCallItemResource

Nota: web_search aún no está disponible a través de Azure OpenAI.

Nombre	Tipo	Description	Obligatorio	Predeterminado
acción	objeto		Sí
└─ Tipo	OpenAI.WebSearchActionType		No
estado	enum	El estado de la llamada a la herramienta de búsqueda web. Valores posibles: in_progress, searching, completed, failed	Sí
type	enum	Valores posibles: web_search_call	Sí

PineconeChatDataSource

Nombre	Tipo	Description	Obligatorio	Predeterminado
parameters	objeto	Información del parámetro para controlar el uso de la fuente de datos Pinecone.	Sí
└─ permitir_resultado_parcial	booleano	Si se configura como verdadero, el sistema permitirá que se utilicen resultados de búsqueda parciales, y la solicitud fallará si todas las consultas parciales fallan. Si no se especifica o se especifica como false, se producirá un error en la solicitud si se produce un error en alguna consulta de búsqueda.	No	Falso
Autenticación └	objeto		No
└─ clave	cuerda / cadena		No
└─ Tipo	enum	Valores posibles: api_key	No
└─ dependencia_de_incrustación	objeto	Representación de un origen de vectorización de datos que se puede usar como un recurso de inserción con un origen de datos.	No
└─ Tipo	AzureChatDataSourceVectorizationSourceType	Identificador distintivo para la fuente de vectorización concreta.	No
Entorno └	cuerda / cadena	Nombre de entorno que se va a usar con Pinecone.	No
└─ mapeo_de_campos	objeto	Asignaciones de campos que se aplicarán a los datos utilizados por el origen de datos Pinecone. Tenga en cuenta que los mapeos de campos de contenido son necesarios para Pinecone.	No
└─ campos_de_contenido	array		No
└" content_fields_separator	cuerda / cadena		No
└─ campo_de_ruta_de_archivo	cuerda / cadena		No
└─ campo_título	cuerda / cadena		No
└" url_field	cuerda / cadena		No
└" in_scope	booleano	Si las consultas deben restringirse al uso de los datos indexados.	No
└─ incluir_contextos	array	Propiedades de contexto de salida que se van a incluir en la respuesta. De forma predeterminada, se solicitarán citas e intenciones.	No	['citas', 'intención']
└" index_name	cuerda / cadena	El nombre del índice de la base de datos Pinecone que se usará.	No
└" max_search_queries	entero	Número máximo de consultas reescritas que se deben enviar al proveedor de búsqueda para un único mensaje de usuario. De forma predeterminada, el sistema realizará una determinación automática.	No
└─ estrictez	entero	La configuración estricta del filtrado de relevancia de búsqueda. Una mayor precisión aumentará la precisión, pero la menor recuperación de la respuesta.	No
└" top_n_documents	entero	Número configurado de documentos que se van a presentar en la consulta.	No
type	enum	Identificador de tipo discriminado, que siempre es "pinecone". Valores posibles: pinecone	Sí

Calidad

Calidad del contenido de vídeo que se va a recuperar. Esto especifica la calidad del contenido de vídeo que se debe devolver.

Propiedad	Importancia
Descripción	Calidad del contenido de vídeo que se va a recuperar. Esto especifica la calidad del contenido de vídeo que se debe devolver.
Tipo	cuerda / cadena
Valores	high low

ResponseFormatJSONSchemaRequest

Nombre	Tipo	Description	Obligatorio	Predeterminado
json_schema	objeto	Esquema JSON para el formato de respuesta	Sí
type	enum	Tipo de formato de respuesta Valores posibles: json_schema	Sí

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 modelo gpt-4o-audio-preview también se puede usar para generar audio. Para solicitar que este modelo genere respuestas de texto y audio, puede usar:

["text", "audio"]

Matriz de: cadena

SpeechGenerationResponseFormat

Formatos de salida de audio admitidos para texto a voz.

Este componente puede ser uno de los siguientes:

VideoGeneration

Resultado de la generación de vídeos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	El momento en que se creó la generación de video.	Sí
altura	entero	Alto del vídeo.	Sí
id	cuerda / cadena	Identificador de la generación de vídeo.	Sí
job_id	cuerda / cadena	El identificador del trabajo de generación de vídeo para este vídeo.	Sí
n_seconds	entero	Duración de la generación de vídeo.	Sí
objeto	enum	Valores posibles: video.generation	Sí
inmediato	cuerda / cadena	Solicitud de esta generación de vídeo.	Sí
Ancho	entero	Ancho del vídeo.	Sí

VideoGenerationJob

Un trabajo de generación de vídeos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
fecha_de_creación	entero	Hora a la que se creó el trabajo.	Sí
expires_at	entero	Hora a la que el trabajo se elimina automáticamente del servicio. El contenido de vídeo y los metadatos del trabajo deben almacenarse antes de esta fecha para evitar la pérdida de datos.	No
failure_reason	string (consulte los modelos válidos a continuación)		No
finished_at	entero	Hora en la que el trabajo finalizó con todas las generaciones de vídeos.	No
Generaciones	array	Vídeos generados para este trabajo. El número depende del n_variants especificado y del éxito de creación de las generaciones.	No
altura	entero	Alto del vídeo.	Sí
id	cuerda / cadena	Id. del trabajo.	Sí
inpaint_items	array	Elementos opcionales de inpainting para este trabajo de generación de vídeo.	No
modelo	cuerda / cadena	Nombre de la implementación que se va a usar para este trabajo de generación de vídeos.	Sí
n_seconds	entero	Duración del trabajo de generación de vídeo.	Sí
n_variants	entero	Número de vídeos que se van a crear como variantes para este trabajo de generación de vídeos.	Sí
objeto	enum	Valores posibles: video.generation.job	Sí
inmediato	cuerda / cadena	Solicitud de este trabajo de generación de vídeo.	Sí
estado	objeto	Estado de un trabajo de generación de vídeo.	Sí
Ancho	entero	Alto del vídeo.	Sí

VideoGenerationJobList

Una lista de trabajos de generación de vídeos.

Nombre	Tipo	Description	Obligatorio	Predeterminado
datos	array	La lista de trabajos de generación de vídeo.	Sí
first_id	cuerda / cadena	Identificador del primer trabajo de la página actual, si está disponible.	No
has_more	booleano	Marca que indica si hay más trabajos disponibles después de la lista.	Sí
last_id	cuerda / cadena	Identificador del último trabajo de la página actual, si está disponible.	No
objeto	enum	Valores posibles: list	Sí

Pasos siguientes

Obtenga más información sobre los modelos y el ajuste preciso con la API de REST. Obtenga más información sobre los modelos underlying que potencian Azure OpenAI.