api client py

Client de l'API Cat Cheshire

API pour développer des clients Python pour interagir avec le Cheshire Cat.

Le package permet d'instancier un client WebSocket et fournit à l'API d'interagir avec tous les points de terminaison.

Une partie de ce package Python est automatiquement générée par le projet OpenAPI Generator.

Pour une documentation plus approfondie sur les points de terminaison disponibles, veuillez vous référer à l'API Redoc. La documentation officielle du Cheshire Cat est disponible ici.

Exigences.

Python 3.10

Installation et utilisation

Installation de PIP

Vous pouvez installer l'API avec pip :

pip install cheshire-cat-api

Puis importez le package:

 import cheshire_cat_api as ccat

Interagir avec les points de terminaison HTTP

API disponibles

Le CatClient a les attributs suivants pour interfacer facilement avec les API associées:

• mémoire
• plugins
• lapin_hole
• statut
• bordel
• paramètres
• LLM

Connexion instancielle

 import cheshire_cat_api as ccat

# A config is necessary to set up base parameters like
# URL, port, user_id, etc.
config = ccat . Config ( user_id = "my_user_42" )

# Connect to the API
cat_client = ccat . CatClient (
    config = config
)

API du plugin - Récupérer les plugins

 # Now retrieve a list of the available plugins
plugins = cat_client . plugins . get_available_plugins ()

API Rabbithole - Téléchargez une URL

 from cheshire_cat_api . models . body_upload_url import BodyUploadUrl

# Please note that interacting with the RabbitHole to upload
# a URL requires structuring the body like this

body_upload_url = BodyUploadUrl (
    url = "https://cheshire-cat-ai.github.io/docs/conceptual/cheshire_cat/rabbit_hole/"
)

# then you can make the request as follows
response = cat_client . rabbit_hole . upload_url ( body_upload_url )

Envoyer un message WebSocket

 import time
import cheshire_cat_api as ccat

# A config is necessary to set up base parameters like
# URL, port, user_id, etc.
config = ccat . Config ( user_id = "my_user_42" )
cat_client = ccat . CatClient ( config = config )

# Connect to the WebSocket API
cat_client . connect_ws ()

while not cat_client . is_ws_connected : 
# A better handling is strongly advised to avoid an infinite loop 
    time . sleep ( 1 )
    
# Send the message
cat_client . send ( message = "Hello Cat!" )

# Close connection
cat_client . close ()

Documentation de la configuration

Les deux cours sont disponibles avec:

 from cheshire_cat_api import Config

Classe	Nom	Défaut	Description
Configurer	base_url	"localhost"	URL de base où le chat est hébergé
Configurer	port	1865	port pour la connexion
Configurer	user_id	"utilisateur"	ID du client
Configurer	auth_key	""	Clé d'authentification pour les points de terminaison HTTP
Configurer	secure_connection	FAUX	Si utiliser un protocole sécurisé

API de bas niveau

Pour une utilisation plus avancée, vous pouvez interagir directement avec le client généré automatiquement. Pour la documentation, voir ici