Création d’agents IA personnalisés avec l’API Agent
Objectifs de formation
- Décrire comment se lancer avec l’API Agent
- Démarrer une session avec un agent IA à l’aide de l’API Agent et gérer le cycle de vie de la session
Premiers pas avec l’API Agent
Vous êtes un développeur chargé d’intégrer Agentforce à votre site Web afin que les agents IA Salesforce puissent aider vos clients en apportant des réponses rapides et utiles à leurs questions.
Vous savez que cela simplifiera vos flux de travail et améliorera les interactions des utilisateurs, mais par où commencer ? Découvrez l’API Agent.
Passons en revue les étapes à un niveau élevé pour faire fonctionner Agentforce avec l’API Agent.
Étape 1 : Activation d’Agentforce et d’un agent
Tout d’abord, vous devez activer Agentforce dans votre organisation Salesforce. Il s’agit d’une étape cruciale, car sans elle, aucune des configurations ultérieures ne fonctionnera. Une fois Agentforce activé, vous devez activer au moins un agent.
L’API Agent ne prend pas en charge les agents de type Agentforce (par défaut).
Étape 2 : création d’une application cliente externe et activation des paramètres OAuth
Vous devez ensuite créer une application cliente externe dans Salesforce. Cette application gère le flux d’identifiants clients, ce qui est essentiel pour des appels d’API sécurisés. Activez les paramètres OAuth pour l’API.
Étape 3 : obtention de la clé consommateur et du secret consommateur
Une fois votre application configurée, vous devez obtenir la clé consommateur et le secret consommateur. Ces informations d’identification sont essentielles pour authentifier vos appels d’API. Vous pouvez les retrouver dans votre application cliente externe.
Étape 4 : création d’un jeton
Tous les appels à l’API Agent nécessitent un jeton. Ce jeton est utilisé pour authentifier vos appels d’API. Vous pouvez créer un jeton à l’aide de la clé consommateur, du secret consommateur et de votre nom de domaine.
Mise en pratique : votre premier appel d’API
Vient maintenant la partie passionnante : effectuer des appels à l’API Agent.
Avant de réaliser l’appel, vous devez recueillir certaines informations auprès de votre organisation. Pour en savoir plus, découvrez comment appeler l’API dans le Guide du développeur de l’API Agent.
À l’aide d’une interface de ligne de commande, exécutez cette commande cURL pour créer une session d’agent avec l’API Agent.
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
}'Lorsque cet appel réussit, vous recevez une réponse avec un ID de session et des informations supplémentaires. Voici un exemple de réponse.
{
"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": []
}
]
}Vous pouvez maintenant commencer à envoyer des messages à l’agent IA.
L’API Agent prend en charge la gestion des messages synchrones et en continu. Les messages synchrones sont idéaux pour les cas d’utilisation où vous avez besoin d’une réponse complète en un seul appel, tandis que les messages en continu sont plus adaptés pour les interactions en temps réel comme les conversations par chat.
Une fois que vous avez terminé, n’oubliez pas de fermer la session.
Éléments à prendre en compte
-
Utilisation des données : le recours à l’API Agent a un impact sur l’utilisation de crédits, comme décrit dans Utilisation et facturation de l’IA générative.
-
Délais d’expiration de l’API : l’API Agent a un délai d’expiration de 120 secondes. Si un appel expire, vous recevez une réponse HTTP 500.
Récapitulatif
Le tour est joué. Utilisez le guide Premiers pas avec l’API Agent et un exemple de code pour commencer à intégrer Agentforce à votre site Web et améliorer l’expérience de vos clients.