Obtenir les informations de l'agent

Obtenez les informations de base de l'agent.

Méthode de requête

GET

URL de la requête

https://api-${endpoint}.gptbots.ai/v1/bot/detail

Authentification de la requête

Consultez la vue d'ensemble pour les détails d'authentification.

Requête

Exemple de requête

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/detail' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/detail' \
-H 'Authorization: Bearer ${API Key}'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Bearer ${API Key}	Utilisez Authorization: Bearer ${API Key} pour l'authentification. Obtenez votre clé API depuis la page Clés API.

Paramètres de la requête

Aucun.

Réponse

Exemple de réponse

{ "bot_id": "645dd86606931c4a9e0ffb1e", "name": "Application conversationnelle", "logo": "https://res.gptbots.ai/ailab/images/default_avatar.png", "bot_type": "QuestionAnswer", "welcome_message": "Message de bienvenue lors de la première utilisation de l'agent", "introduction": "Présentation de l'agent", "tags": "Tags de l'agent", "identity_prompt": "Invite d'identité de l'agent", "creativity_level": 0.3, "doc_correlation": 0.2, "irrelevant_questions": true, "question_limit": 100, "long_term_memory": true }

                      
                      {
  "bot_id": "645dd86606931c4a9e0ffb1e",
  "name": "Application conversationnelle",
  "logo": "https://res.gptbots.ai/ailab/images/default_avatar.png",
  "bot_type": "QuestionAnswer",
  "welcome_message": "Message de bienvenue lors de la première utilisation de l'agent",
  "introduction": "Présentation de l'agent",
  "tags": "Tags de l'agent",
  "identity_prompt": "Invite d'identité de l'agent",
  "creativity_level": 0.3,
  "doc_correlation": 0.2,
  "irrelevant_questions": true,
  "question_limit": 100,
  "long_term_memory": true
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
bot_id	string	ID de l'agent.
name	string	Nom de l'agent.
logo	string	Avatar de l'agent.
bot_type	string	Type d'agent, valeur : QuestionAnswer, Flow.
welcome_message	string	Message de bienvenue lors de la première utilisation de l'agent.
introduction	string	Présentation de l'agent.
tags	array	Tags de l'agent.
identity_prompt	string	Invite d'identité de l'agent.
creativity_level	float	Niveau de créativité, valeur : 0-1.
doc_correlation	float	Corrélation documentaire, valeur : 0-1.
irrelevant_questions	boolean	Indique si l'agent répond aux questions sans lien avec le jeu de données. Valeur : true, false.
question_limit	int	Limite de longueur en tokens des questions utilisateur.
long_term_memory	boolean	Indique si la mémoire à long terme est activée.

Réponse en cas d'échec

Champ	Type	Description
code	int	Code d'erreur.
message	string	Détails de l'erreur.

Codes d'erreur

Code	Message
40127	Échec de l'authentification du développeur
20059	Agent supprimé