Documentación de Oracle Cloud Infrastructure

API de conversaciones de OCI

Utilice la API de conversaciones de OCI para gestionar la memoria de la sesión. Con la API Conversations, primero se crea una conversación y, a continuación, se incluye el ID de conversación en la solicitud de API Responses. Esto crea un objeto de conversación dedicado que puede reutilizar en turnos.

Nota

La API de conversaciones de OCI utiliza el mismo formato que la API de conversaciones de OpenAI con el punto final compatible con OpenAI de OCI. Para obtener información sobre la sintaxis y la solicitud, consulte la documentación de la API de conversaciones de OpenAI. Para conocer las propiedades no soportadas, consulte la sección Limitaciones de OCI para cada operación de esta página.

Punto final de API soportado

URL Base Ruta de punto final Autenticación
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /conversations Clave de API o sesión de IAM

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.

Consejo

Para conocer los pasos de configuración antes de utilizar esta API, consulte Inicio rápido.

Creación de una conversación

POST /conversations

Referencia

Crear una conversación

Ejemplo de Python:

# create a conversation
conversation = client.conversations.create(
   ...
)
print(conversation.id)
Limitaciones de OCI
Ninguno

Recuperación de una conversación

GET /conversations/{conversation_id}

Referencia

Recuperar conversación

Ejemplo de Python:

# retrieve a conversation
conversation = client.conversations.retrieve(
    "conversation_id",
)
print(conversation.id)
Limitaciones de OCI
Ninguno

Actualización de una conversación

POST /conversations/{conversation_id}

Referencia

Actualizar Conversación

Ejemplo de Python:

# update a conversation
updated_conversation = client.conversations.update(
   ...
)
print(updated_conversation)
Limitaciones de OCI
Ninguno

Supresión de una conversación

DELETE /conversations/{conversation_id}

Referencia

Suprimir Conversación

Ejemplo de Python:

# delete a conversation
client.conversations.delete(
    "conversation_id"
)
Limitaciones de OCI
Ninguno

Crea tu primera conversación

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",
)

# create a conversation
conversation = client.conversations.create(
    metadata={"topic": "offsite"}
)
print("Conversation ID:", conversation.id)

# first question
response1 = client.responses.create(
    model="openai.gpt-oss-120b",
    input="Give me three ideas for a team offsite.",
    conversation=conversation.id,
)
print("Response 1:", response1.output_text)

# second question
response2 = client.responses.create(
    model="openai.gpt-oss-120b",
    input="Make the second idea more budget friendly.",
    conversation=conversation.id,
)
print("Response 2:", response2.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 un proyecto de IA generativa de OCI ya creado para la solicitud.