Criar agentes de IA personalizados com a API do agente
Objetivos de aprendizagem
- Descrever como começar a usar a API do agente.
- Iniciar uma sessão com um agente de IA, usando a API do agente, e gerenciar o ciclo de vida da sessão.
Introdução à API do agente
Você é um desenvolvedor encarregado de integrar o Agentforce em seu site, para que os agentes de IA do Salesforce possam ajudar seus clientes com respostas rápidas e úteis às suas perguntas.
Você sabe que isso simplificará seus fluxos de trabalho e melhorará as interações com os usuários, mas por onde começar? Comece por acessar a API do agente.
Vamos percorrer as etapas de maneira geral para começar a usar o Agentforce com a API do agente.
Etapa 1: Ativar o Agentforce e um agente
Primeiro, você precisa ativar o Agentforce na sua organização do Salesforce. Este é um passo fundamental, pois sem ele nenhuma das configurações subsequentes funcionará. Após ativar o Agentforce, você precisa ativar pelo menos um agente.
A API do agente não suporta agentes do tipo “Agentforce (Padrão)”.
Etapa 2: Criar um aplicativo conectado e ativar configurações do OAuth
Em seguida, você precisa criar um aplicativo conectado no Salesforce. Este aplicativo trata do fluxo de credenciais do cliente, que é essencial para chamadas de API seguras. Ative as configurações do OAuth para API.
Etapa 3: Adicionar o aplicativo conectado ao seu agente
Agora, você precisa adicionar o aplicativo conectado ao seu agente. Isso é feito na guia Connections (Conexões) em sua organização do Salesforce. Essa etapa associa seu aplicativo conectado ao agente, permitindo que você faça chamadas de API.
Etapa 4: Obter a chave de cliente e o segredo de cliente
Após configurar seu aplicativo conectado, você precisa obter a chave de cliente e o segredo de cliente. Essas credenciais são essenciais para autenticar suas chamadas de API. Pode encontrá-las em seu aplicativo conectado.
Etapa 5: Criar um token
Todas as chamadas para a API do agente exigem um token. Este token é usado para autenticar suas chamadas de API. Você pode criar um token usando a chave de cliente, o segredo de cliente e seu nome de domínio.
Experimente você mesmo: Faça sua primeira chamada de API
Agora vem a parte empolgante: fazer chamadas para a API do agente.
Antes de fazer a chamada, você precisa reunir algumas informações da sua organização. Para saber mais, consulte Fazer uma chamada para a API no Guia do desenvolvedor da API do agente.
Usando uma interface de linha de comando, execute este comando cURL para criar uma nova sessão de agente com a API do agente.
curl --location -X POST https://api.salesforce.com/einstein/ai-agent/v1/agents/{AGENT_ID}/sessions \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--data '{
"externalSessionKey": "{RANDOM_UUID}",
"instanceConfig": {
"endpoint": "https://{MY_DOMAIN_URL}"
},
"streamingCapabilities": {
"chunkTypes": ["Text"]
},
"bypassUser": true
}'
Se essa chamada for bem-sucedida, você receberá uma resposta com um ID de sessão e informações adicionais. Aqui está um exemplo de resposta.
{
"sessionId": "80ab2e16-392e-4c12-b80a-f028a58400b5",
"_links": {
"self": null,
"messages": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5/messages"
},
"messagesStream": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5/messages/stream"
},
"session": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/agents/0XxHr000000ysOSKAY/sessions"
},
"end": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5"
}
},
"messages": [
{
"type": "Inform",
"id": "d27b7308-f1ab-47bd-949c-0225d5e21a8e",
"feedbackId": "",
"planId": "",
"isContentSafe": true,
"message": "Hi, I'm an AI service assistant. How can I help you?",
"result": [],
"citedReferences": []
}
]
}Agora, você pode começar a enviar mensagens para o agente de IA.
A API do agente suporta o tratamento de mensagens síncronas e de streaming. As mensagens síncronas são ideais para casos de uso em que você precisa da resposta completa em uma única chamada, enquanto as mensagens de streaming são melhores para interações em tempo real, como conversas de chat.
Quando terminar, não se esqueça de fechar a sessão.
O que você deve considerar
-
Uso de dados: cada chamada para a API do agente consome solicitações do Einstein. O número de solicitações utilizadas depende do tamanho da chamada de API e do multiplicador de tipo de uso do grande modelo de linguagem (LLM).
-
Tempos limite da API: a API do agente tem um tempo limite de 120 segundos. Se uma chamada atingir o tempo limite, você receberá uma resposta HTTP 500.
Resumo
É isso. Use o guia Introdução à API do agente e o código de exemplo para começar a integrar o Agentforce no seu site e a melhorar a experiência dos seus clientes.