ListAIAgentInstance - - Centre de documentation Alibaba Cloud

Consulte la liste des instances d'agent IA. Vous pouvez récupérer toutes les instances ou les filtrer selon des conditions spécifiées.

Description de l'opération

Cette opération vous permet de consulter la liste des instances d'agent IA en fonction de l'identifiant d'agent spécifié (AIAgentId), ainsi que des paramètres facultatifs tels que la plage de temps (StartTime et EndTime), la taille de la page (PageSize) et le numéro de page (PageNumber). La réponse inclut l'état, la configuration d'exécution, la configuration du modèle, les données définies par l'utilisateur et l'URL de téléchargement des journaux d'appels de conversation de chaque instance.

Important Valeurs par défaut des paramètres de pagination : PageSize est 10, PageNumber est 1.

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:ListAIAgentInstance

none

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AIAgentId	string	Oui	L'identifiant de l'agent.	39f8e0bc005e4f309379701645f4***
StartTime	string	Non	L'heure de début de la requête au format ISO 8601. Aucune valeur par défaut.	2023-01-01T00:00:00Z
EndTime	string	Non	L'heure de fin de la requête au format ISO 8601. Aucune valeur par défaut.	2023-01-02T00:00:00Z
PageSize	integer	Non	Le nombre d'entrées par page. Valeur par défaut : 10. Valeurs valides : 0 à 100.	10
PageNumber	integer	Non	Le numéro de page. Valeur par défaut : 1. Valeurs valides : 1 à 100.	1

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
Instances	array<object>	La liste des structures d'instances d'agent.
	object
CallLogUrl	string	L'URL du fichier de journal des appels de conversation de l'agent. Le fichier contient la structure CallLog au format JSON.	https://example.com/call_logs/12345.json
RuntimeConfig	AIAgentRuntimeConfig	La configuration d'exécution requise par l'agent.	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}
Status	string	L'état de l'instance. Valeurs valides : Created : L'appel est initié mais la connexion entre les deux extrémités n'est pas établie. Executing : L'appel est en cours et la connexion entre les deux extrémités est établie. Finished : L'appel est terminé. Valeurs valides : Finished : Terminé. Executing : En cours.	Finished
TemplateConfig `deprecated`	AIAgentTemplateConfig	La configuration du modèle utilisée par l'instance d'agent.	{"VoiceChat": {"VoiceId": "zhixiaoxia"}}
UserData	string	Les données définies par l'utilisateur.	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}
AgentConfig	AIAgentConfig	La configuration du modèle utilisée par l'instance d'agent.
RequestId	string	L'identifiant de la requête.	7B117AF5-2A16-412C-B127-FA6175ED1AD0

Exemples

JSON format

{
  "Instances": [
    {
      "CallLogUrl": "https://example.com/call_logs/12345.json",
      "RuntimeConfig": {
        "AvatarChat3D": {
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "VisionChat": {
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "VoiceChat": {
          "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
          "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
          "ChannelId": "70f22d5784194938a7e387052f2b3208"
        },
        "AgentUserId": "877ae632caae49b1afc81c2e8194ffb4",
        "AuthToken": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx",
        "ChannelId": "70f22d5784194938a7e387052f2b3208\n"
      },
      "Status": "Finished",
      "TemplateConfig": {
        "AvatarChat3D": {
          "AsrMaxSilence": 400,
          "AvatarId": "1231",
          "EnableIntelligentSegment": true,
          "EnablePushToTalk": false,
          "EnableVoiceInterrupt": true,
          "GracefulShutdown": false,
          "Greeting": "早上好，我的朋友！",
          "UseVoiceprint": false,
          "UserOnlineTimeout": 60,
          "VoiceId": "zhixiaoxia",
          "Volume": 100,
          "VoiceprintId": "uniqueId",
          "BailianAppParams": "{}",
          "UserOfflineTimeout": 5,
          "MaxIdleTime": 600,
          "WorkflowOverrideParams": "{}",
          "WakeUpQuery": "今天天气怎么样？",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "LlmHistoryLimit": 10,
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "AsrLanguageId": "zh_mandarin",
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
          "InterruptWords": [
            "停止"
          ],
          "VadLevel": 0,
          "CharBreak": true,
          "AsrHotWords": [
            "检查"
          ]
        },
        "VisionChat": {
          "AsrMaxSilence": 400,
          "EnableIntelligentSegment": true,
          "EnablePushToTalk": false,
          "EnableVoiceInterrupt": true,
          "GracefulShutdown": false,
          "Greeting": "早上好，我的朋友！\n",
          "UseVoiceprint": false,
          "UserOnlineTimeout": 60,
          "VoiceId": "zhixiaoxia",
          "Volume": 100,
          "VoiceprintId": "uniqueId",
          "BailianAppParams": "{}",
          "UserOfflineTimeout": 5,
          "MaxIdleTime": 600,
          "WorkflowOverrideParams": "{}",
          "WakeUpQuery": "今天天气怎么样？",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "LlmHistoryLimit": 10,
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "AsrLanguageId": "zh_mandarin",
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
          "InterruptWords": [
            "停止"
          ],
          "VadLevel": 0,
          "CharBreak": true,
          "AsrHotWords": [
            "检查"
          ]
        },
        "VoiceChat": {
          "AsrMaxSilence": 400,
          "EnableIntelligentSegment": true,
          "EnablePushToTalk": false,
          "EnableVoiceInterrupt": true,
          "GracefulShutdown": false,
          "Greeting": "早上好，我的朋友",
          "UseVoiceprint": false,
          "UserOnlineTimeout": 60,
          "VoiceId": "zhixiaoxia",
          "Volume": 100,
          "VoiceprintId": "uniqueId",
          "BailianAppParams": "{}",
          "UserOfflineTimeout": 5,
          "AvatarUrl": "http://example.com/a.jpg",
          "AvatarUrlType": "USER",
          "MaxIdleTime": 600,
          "WorkflowOverrideParams": "{}",
          "WakeUpQuery": "今天天气怎么样？",
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "LlmHistoryLimit": 10,
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "AsrLanguageId": "zh_mandarin",
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。",
          "InterruptWords": [
            "停止"
          ],
          "VadLevel": 11,
          "CharBreak": true,
          "AsrHotWords": [
            "检查"
          ]
        }
      },
      "UserData": "{\"Email\":\"johndoe@example.com\",\"Preferences\":{\"Language\":\"en\"}}",
      "AgentConfig": {
        "Greeting": "你好",
        "WakeUpQuery": "今天天气怎么样？\n",
        "MaxIdleTime": 600,
        "UserOnlineTimeout": 60,
        "UserOfflineTimeout": 5,
        "EnablePushToTalk": false,
        "GracefulShutdown": true,
        "Volume": 100,
        "WorkflowOverrideParams": "{}",
        "AvatarUrl": "http://example.com/a.jpg\n",
        "AvatarUrlType": "USER",
        "EnableIntelligentSegment": true,
        "AsrConfig": {
          "AsrLanguageId": "zh_mandarin",
          "AsrMaxSilence": 400,
          "AsrHotWords": [
            "检查"
          ],
          "VadLevel": 11,
          "CustomParams": "mode=fast&sample=16000&format=wav",
          "VadDuration": 300
        },
        "TtsConfig": {
          "VoiceId": "longcheng_v2\n\n",
          "VoiceIdList": [
            "zhixiaoxia"
          ],
          "PronunciationRules": [
            {
              "Word": "一一零",
              "Pronunciation": "幺幺零",
              "Type": "replacement"
            }
          ],
          "ModelId": "speech-01-turbo",
          "LanguageId": "Chinese",
          "Emotion": "happy",
          "SpeechRate": 1
        },
        "LlmConfig": {
          "LlmHistory": [
            {
              "Role": "user",
              "Content": "你好"
            }
          ],
          "LlmHistoryLimit": 10,
          "LlmSystemPrompt": "你是一位友好且乐于助人的助手，专注于为用户提供准确的信息和建议。\n",
          "BailianAppParams": "\"{\\\"biz_params\\\":{\\\"user_defined_params\\\":{\\\"your_plugin_id\\\":{\\\"article_index\\\":2}}},\\\"memory_id\\\":\\\"your_memory_id\\\",\\\"image_list\\\":[\\\"https://your_image_url\\\"],\\\"rag_options\\\":{\\\"pipeline_ids\\\":[\\\"your_id\\\"],\\\"file_ids\\\":[\\\"文档ID1\\\",\\\"文档ID2\\\"],\\\"metadata_filter\\\":{\\\"name\\\":\\\"张三\\\"},\\\"structured_filter\\\":{\\\"key1\\\":\\\"value1\\\",\\\"key2\\\":\\\"value2\\\"},\\\"tags\\\":[\\\"标签1\\\",\\\"标签2\\\"]}}\"",
          "OpenAIExtraQuery": "api-version=2024-02-01&api-key=sk-xxx",
          "LlmCompleteReply": true,
          "FunctionMap": [
            {
              "Function": "hangup",
              "MatchFunction": "hangup"
            }
          ],
          "OutputMinLength": 5,
          "OutputMaxDelay": 2000,
          "HistorySyncWithTTS": false
        },
        "AvatarConfig": {
          "AvatarId": "5257"
        },
        "InterruptConfig": {
          "EnableVoiceInterrupt": true,
          "InterruptWords": [
            "打断一下"
          ],
          "NoInterruptMode": "cache",
          "KeepInterruptWordsForLLM": true
        },
        "VoiceprintConfig": {
          "UseVoiceprint": false,
          "VoiceprintId": "zhixiaoxia",
          "RegistrationMode": "Explicit"
        },
        "TurnDetectionConfig": {
          "TurnEndWords": [
            "我说完了"
          ],
          "Mode": "Semantic",
          "SemanticWaitDuration": -1,
          "Eagerness": "High"
        },
        "ExperimentalConfig": "\"\"",
        "VcrConfig": {
          "StillFrameMotion": {
            "Enabled": false,
            "CallbackDelay": 3000
          },
          "InvalidFrameMotion": {
            "Enabled": false,
            "CallbackDelay": 3000
          },
          "PeopleCount": {
            "Enabled": false
          },
          "Equipment": {
            "Enabled": false
          },
          "HeadMotion": {
            "Enabled": false
          },
          "LookAway": {
            "Enabled": true
          }
        },
        "AmbientSoundConfig": {
          "ResourceId": "f67901c595834************",
          "Volume": 50
        },
        "AutoSpeechConfig": {
          "UserIdle": {
            "WaitTime": 5000,
            "MaxRepeats": 5,
            "Messages": [
              {
                "Text": "您还在吗？",
                "Probability": 0.5
              }
            ],
            "HangupEndWord": "我挂了，再见"
          },
          "LlmPending": {
            "WaitTime": 3000,
            "Mode": "",
            "Messages": [
              {
                "Text": "稍等一下",
                "Probability": 0.5
              }
            ]
          }
        },
        "BackChannelingConfigs": [
          {
            "Enabled": true,
            "TriggerStage": "pause_detected",
            "Probability": 0.5,
            "Words": [
              {
                "Text": "嗯嗯",
                "Probability": 0.3
              }
            ]
          }
        ],
        "BackChannelingConfig": [
          {
            "Enabled": true,
            "TriggerStage": "pause_detected",
            "Probability": 0.5,
            "Words": [
              {
                "Text": "嗯嗯",
                "Probability": 0.3
              }
            ]
          }
        ]
      }
    }
  ],
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0"
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.