Documentação do Oracle Cloud Infrastructure

API de Conversas do OCI

Usar a API de Conversas do OCI para gerenciar a memória da sessão. Com a API Conversas, você cria uma conversa primeiro e depois inclui o ID da conversa na solicitação da API Respostas. Isso cria um objeto de conversa dedicado que você pode reutilizar em turnos.

Observação

A API de Conversas do OCI usa o mesmo formato da API de Conversas do OpenAI com o ponto final compatível com o OCI OpenAI. Para obter detalhes de sintaxe e solicitação, consulte a documentação da API OpenAI Conversations. Para obter propriedades não suportadas, consulte a seção Limitações do OCI de cada operação nesta página.

Ponto Final de API Suportado

URL Base Caminho do Ponto Final Autenticação
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1 /conversations Chave de API ou sessão do IAM

Substitua ${region} por uma região suportada, como us-chicago-1.

Embora o formato de solicitação seja compatível com OpenAI, a autenticação usa credenciais da OCI, as solicitações são roteadas por meio de pontos finais de inferência da OCI Generative AI e os recursos e a execução permanecem na OCI.

Dica

Para saber as etapas de configuração antes de usar essa API, consulte Início Rápido.

Autenticação

Você pode acessar os pontos finais compatíveis com o OCI OpenAI de duas maneiras:

Use chaves de API para teste e desenvolvimento antecipado. Usar autenticação baseada em IAM para cargas de trabalho de produção e ambientes gerenciados pela OCI.

Criando uma Conversa

POST /conversations

Referência

Criar conversa

Exemplo de Python:

# create a conversation
conversation = client.conversations.create(
   ...
)
print(conversation.id)
Limitações do OCI
Nenhum

Recuperando uma conversa

GET /conversations/{conversation_id}

Referência

Recuperar conversa

Exemplo de Python:

# retrieve a conversation
conversation = client.conversations.retrieve(
    "conversation_id",
)
print(conversation.id)
Limitações do OCI
Nenhum

Atualizando uma Conversa

POST /conversations/{conversation_id}

Referência

Atualizar conversa

Exemplo de Python:

# update a conversation
updated_conversation = client.conversations.update(
   ...
)
print(updated_conversation)
Limitações do OCI
Nenhum

Excluindo uma Conversa

DELETE /conversations/{conversation_id}

Referência

Excluir conversa

Exemplo de Python:

# delete a conversation
client.conversations.delete(
    "conversation_id"
)
Limitações do OCI
Nenhum

Crie sua primeira conversa

O exemplo a seguir usa o OpenAI SDK com o ponto final compatível com o OCI OpenAI, uma chave de API do OCI Generative AI e um OCID de projeto:

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)

Neste exemplo:

  • base_url aponta para o ponto final compatível com o OCI OpenAI.
  • O client.responses.create(...) chama a API de Respostas do OCI.
  • project identifica um projeto do OCI Generative AI já criado para a solicitação.