GenerateAIAgentCall - - Centre de documentation Alibaba Cloud

Crée une instance d'agent et renvoie le canal, le nom d'utilisateur et le jeton pour rejoindre le canal.

Description de l'opération

Cette API crée une instance d'agent en utilisant l'identifiant de l'agent IA (AIAgentId) spécifié. Vous pouvez utiliser les informations contenues dans la réponse pour rejoindre le canal correspondant et démarrer une session avec l'agent.

Important

Assurez-vous que l'identifiant de l'agent IA spécifié est valide et configurez les paramètres facultatifs selon vos besoins.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

ice:GenerateAIAgentCall

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AIAgentId	string	Oui	L'identifiant de l'agent IA.	39f8e0bc005e4f309379701645f4****
Expire	integer	Non	Facultatif. Le délai d'expiration du jeton en secondes. Valeur par défaut : 3600. Plage de valeurs : 0 à 604800.	3600
UserId	string	Non	Le nom d'utilisateur dans le canal. Si vous ne spécifiez pas de nom d'utilisateur, un nom est automatiquement généré. Le nom d'utilisateur peut comporter jusqu'à 64 caractères.	877ae632caae49b1afc81c2e8194ffb4
TemplateConfig `deprecated`	AIAgentTemplateConfig	Non	Cette configuration fusionne avec la configuration du modèle d'agent dans la console. Si vous omettez ce paramètre, l'agent utilise la configuration par défaut de la console. Remarque La configuration du modèle d'agent. Ce paramètre est obsolète. Utilisez plutôt le paramètre AgentConfig.
UserData	string	Non	Les données utilisateur.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
SessionId	string	Non	Un identifiant unique pour la session. S'il n'est pas fourni, une nouvelle session est créée.	fw1gr0bc005e4f309379701645f4****
AgentConfig	AIAgentConfig	Non	La configuration du modèle d'agent. La configuration que vous fournissez fusionne avec la configuration du modèle d'agent dans la console. Si vous omettez ce paramètre, l'agent utilise la configuration par défaut de la console. Remarque Compatibilité avec TemplateConfig : les champs dans AgentConfig sont prioritaires. Si un champ est spécifié dans TemplateConfig mais pas dans AgentConfig, le système utilise la valeur de TemplateConfig. Nous vous recommandons d'utiliser AgentConfig plutôt que TemplateConfig.
ChatSyncConfig	object	Non	La configuration de synchronisation des discussions.
IMAIAgentId	string	Non	L'identifiant de l'agent de messagerie instantanée (IM).	****005e4f309379701645f4**
ReceiverId	string	Non	L'identifiant utilisateur du destinataire.	4167626d312034b2b1c3b7f2f3e41884

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
AIAgentUserId	string	Le nom de l'agent dans le canal Alibaba Real-time Communication (ARTC).	877ae632caae49b1afc81c2e8194ffb4
ChannelId	string	L'identifiant du canal ARTC.	70f22d5784194938a7e387052f2b3208
InstanceId	string	L'identifiant de l'instance d'agent générée.	39f8e0bc005e4f309379701645f4****
RequestId	string	L'identifiant de la requête.	7B117AF5-2A16-412C-B127-FA6175ED1AD0
Token	string	Le jeton ARTC côté client.	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
UserId	string	Le nom d'utilisateur dans le canal ARTC.	user123
AvatarUserId	string	L'identifiant utilisateur de l'avatar dans le canal.	avatar_39f8e0bc005e4f309379701645f4****

Exemples

JSON format

{
  "AIAgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
  "ChannelId": "70f22d5784194938a7e387052f2b3208",
  "InstanceId": "39f8e0bc005e4f309379701645f4****",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
  "UserId": "user123",
  "AvatarUserId": "avatar_39f8e0bc005e4f309379701645f4****"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.