API de respuestas de OCI

Utilice la API Responses junto con los siguientes componentes de creación de agentes en OCI Generative AI:

Si es necesario, puede utilizar los bloques de creación básicos de bajo nivel con la API Responses.

Utilice la API Responses para:

• Llamar a modelos alojados y modelos importados compatibles.
• Envía entradas de texto e imagen y recibe salidas de texto.
• Generar texto o salidas estructuradas.
• Ejecute peticiones de datos de un solo paso o flujos de trabajo de varios pasos.
• Agregue las herramientas admitidas en la solicitud.
• Vuelva a enviar las respuestas al cliente.
• Utilizar el estado de conversación gestionado por OCI a través de la API Conversations.
• Reutilice el historial de conversaciones o las salidas anteriores como contexto para solicitudes posteriores.
• Conecte el modelo a sistemas y datos externos a través de llamadas de función y llamadas MCP.
• Combine solicitudes de modelo con archivos, almacenes de vectores o contenedores cuando sea necesario.

Esto le permite empezar con una petición de datos simple y ampliar a flujos de trabajo más avanzados sin cambiar a una API diferente.

Para la mayoría de las aplicaciones nuevas, comience con la API de respuestas.

Utilícelo cuando desee:

• Utilice una API para la interacción del modelo y las capacidades ágentes.
• Agregar herramientas soportadas a una solicitud de modelo.
• Utilizar el historial de conversaciones gestionadas por OCI.
• Generar salidas estructuradas.
• Cree flujos de trabajo que también puedan utilizar archivos, almacenes vectoriales o contenedores cuando sea necesario.

Sustituya ${region} por una región de OCI soportada como us-chicago-1.

Aunque el formato de solicitud es compatible con OpenAI, la autenticación utiliza credenciales de OCI, las solicitudes se enrutan a través de puntos finales de inferencia de OCI Generative AI y los recursos y la ejecución permanecen en OCI.

Puede acceder a los puntos finales compatibles con OpenAI de OCI de dos formas:

• Claves de API de OCI Generative AI
• Autenticación basada en IAM de OCI

Utilice claves de API para las pruebas y el desarrollo temprano. Utiliza la autenticación basada en IAM para cargas de trabajo de producción y entornos gestionados por OCI.

Antes de llamar a la API de respuestas:

• Crea un proyecto de OCI Generative AI. Las llamadas de API compatibles con OpenAI de OCI requieren un proyecto.
• Configure el cliente con la URL base compatible con OpenAI de OCI.
• Configurar la autenticación.
• Utilizar un modelo soportado en una región soportada.

Para conocer los pasos de configuración, consulte Inicio rápido, Autenticación y Modelos y regiones soportados.

Para llamar a la API de respuestas desde el código, recomendamos utilizar el SDK de OpenAI. Consulte QuickStart.

En el siguiente ejemplo se utiliza el SDK de OpenAI con el punto final compatible con OCI OpenAI, una clave de API de OCI Generative AI y un OCID de proyecto:

from openai import OpenAI

client = OpenAI(
    base_url="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1",
    api_key="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    project="ocid1.generativeaiproject.oc1.us-chicago-1.xxxxxxxx",
)

response = client.responses.create(
    model="<supported-model-id>",
    input="Write a one-sentence explanation of what a database is."
)

print(response.output_text)

En este ejemplo:

• base_url apunta al punto final compatible con OpenAI de OCI.
• client.responses.create(...) llama a la API de respuestas de OCI.
• project identifica el proyecto de OCI Generative AI para la solicitud.

Para permitir que OCI gestione el historial de conversaciones de varios giros, primero cree una conversación:

conversation = client.conversations.create()

A continuación, incluya el ID de conversación en la solicitud de API de respuestas:

response = client.responses.create(
  model="<supported-model-id>",
  input=[
        {
            "role": "user",
            "content": "Recommend a restaurant based on the food I like."
        }
    ],
    conversation=conversation.id,
)

Utilice este patrón cuando desee que OCI gestione el estado de la conversación entre solicitudes.

Para obtener más información sobre las capacidades de memoria, consulte la API de conversaciones, la memoria a corto plazo, la memoria a largo plazo y la compactación de memoria a corto plazo.

La API Responses soporta flujos de trabajo activados para herramientas mediante la propiedad tools. En muchos casos de uso, puedes declarar las herramientas de la solicitud y permitir que OCI Generative AI coordine la ejecución del modelo y el uso de herramientas.

El soporte de herramientas solo está disponible a través de la API.

En el siguiente ejemplo, se define una herramienta MCP en la solicitud:

response = client.responses.create(
    model="openai.gpt-oss-120b",
    tools=[
        {
            "type": "mcp",
            "server_url": "https://example.com/mcp",
        }
    ],
    input="What events are scheduled for 2026-04-02?"
)

En este ejemplo, la API Responses llama al modelo y transfiere la definición de la herramienta MCP como parte de la misma solicitud. No necesita una API específica de MCP independiente.

Puede utilizar los bloques de creación de agentes fundamentales de bajo nivel con la API de respuestas cuando su flujo de trabajo necesite control directo sobre archivos, almacenes de vectores o contenedores.

Entre los ejemplos comunes se incluyen:

• Carga de archivos antes de enviar una solicitud de modelo
• Gestión directa del contenido del almacén de vectores
• Reutilización de archivos o recursos en varias solicitudes
• Trabajar con contenedores de sandbox como parte de un flujo de trabajo más amplio

La siguiente API se suele utilizar con la API de respuestas:

file_response = client.files.create(
    file=open("example-document.pdf", "rb"),
    purpose="assistants"
)

file_id = file_response.id

response = client.responses.create(
    model="<model-id>",
    input=[
        {
            "role": "user",
            "content": [
                { "type": "input_file", "file_id": file_id },
                { "type": "input_text", "text": "List all the cities mentioned in this document." }
            ]
        }
    ]
)

Puede utilizar la API de respuestas de OCI con el SDK de OpenAI. También puede utilizarlo con marcos de agente de cliente compatibles.

El SDK de OpenAI soporta estos lenguajes:

• Python
• Java
• TypeScript
• Ir
• .NET

Más apoyo lingüístico está disponible a través de bibliotecas comunitarias.

Los marcos de agentes compatibles incluyen:

• SDK de agentes de OpenAI (recomendado)
• SDK de OpenAI Codex
• Marco de Microsoft Agent
• LangChain
• LangGraph
• CrewAI
• Generación automática
• Índice de Llama
• Pirata

• API de Conversaciones
• Herramientas de API de respuestas
  • Búsqueda de Archivo
  • Intérprete de código
  • Llamada de función
  • Llamadas de MCP
• API de archivos
• API de tiendas de vectores
• API de contenedores
• Autenticación
  • Claves de API de OCI Generative AI
  • Autenticación basada en IAM de OCI
• Regiones y modelos soportados
• Inicio rapido