Crear agentes de IA personalizados con la API de agente
Objetivos de aprendizaje
- Describir cómo empezar a utilizar la API de agente.
- Iniciar una sesión con un agente de IA mediante el uso de una API de agente y gestionar el ciclo de vida de la sesión.
Primeros pasos con la API de agente
Usted es desarrollador y le han pedido que integre Agentforce en su sitio web, de manera que los agentes de IA de Salesforce puedan ayudar a los clientes proporcionando respuestas rápidas y útiles a sus preguntas.
Sabe que esto hará que sus flujos de trabajo sean más sencillos y mejorará las interacciones de los usuarios pero, ¿por dónde debe empezar? Por introducir una API de agente.
Vamos a ver los pasos de manera general para conseguir que Agentforce se ejecute con la API de agente.
Paso 1: Habilitar Agentforce y activar un agente
Primero, debe habilitar Agentforce en su organización de Salesforce. Este paso es fundamental ya que, sin él, ninguno de los siguientes parámetros funcionarían. Una vez habilitado Agentforce, debe activar al menos un agente.
La API de agente no es compatible con agentes del tipo "Agentforce (Default)" (Agentforce [predeterminado]).
Paso 2: Crear una aplicación de cliente externo y habilitar la configuración de OAuth
A continuación, debe crear una aplicación de cliente externo en Salesforce. Esta aplicación gestiona el flujo de credenciales del cliente, que es fundamental para realizar llamadas de API seguras. Active la configuración de OAuth para la API.
Paso 3: Obtener la clave de consumidor y el secreto de consumidor
Una vez configurada su aplicación, debe obtener la clave de consumidor y el secreto de consumidor. Estas credenciales son esenciales para autenticar las llamadas de API. Puede encontrarlas en su aplicación de cliente externo.
Paso 4: Crear un token
Todas las llamadas a la API de agente requieren un token. Este token se utiliza para autenticar las llamadas de API. Puede crear un token con la clave de consumidor, el secreto de consumidor y su nombre de dominio.
Pruébelo usted mismo: haga su primera llamada de API
Ahora viene la parte interesante: hacer llamadas a la API de agente.
Antes de hacer la llamada, debe recopilar información de su organización. Para obtener más información, consulte Call the API (Llamar a la API) en la guía del desarrollador de la API de agente.
Con una interfaz de línea de comandos, ejecute este comando cURL para crear una nueva sesión de agente con la API de 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
}'Cuando la llamada tenga éxito, recibirá una respuesta con un Id. de sesión e información adicional. Esta es una respuesta de ejemplo.
{
"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": []
}
]
}Ahora puede empezar a enviar mensajes al agente de IA.
La API de agente es compatible con la gestión de mensajes sincrónicos y en streaming. Los mensajes sincrónicos son ideales para los casos de uso en los que se necesita la respuesta completa en una única llamada, mientras que los mensajes en streaming son una mejor opción para las interacciones en tiempo real, como las conversaciones de chat.
Una vez que haya terminado, recuerde cerrar la sesión.
Qué debe tener en cuenta
-
Uso de datos: el uso de la API de agente afecta a su consumo de créditos tal y como se describe en Uso y facturación de IA generativa.
-
Tiempos de espera de API: la API de agente tiene un tiempo de espera de 120 segundos. Si se agota el tiempo de una llamada, recibirá una respuesta HTTP 500.
Resumen
Ya está. Utilice la guía Get Started with the Agent API (Primeros pasos con la API de agente) y código de muestra para empezar a integrar Agentforce en su sitio web y mejorar la experiencia de los clientes.