api client py

Cliente de API de Cheshire Cat

API para desarrollar clientes de Python para interactuar con el Cathire Cat.

El paquete permite instanciar un cliente WebSocket y proporciona la API para interactuar con todos los puntos finales.

Una parte de este paquete Python es generada automáticamente por el proyecto del generador OpenAPI.

Para obtener una documentación más profunda sobre los puntos finales disponibles, consulte la API Redoc. La documentación oficial de Cheshire Cat está disponible aquí.

Requisitos.

Python 3.10

Instalación y uso

Instalación de PIP

Puede instalar la API con pip :

pip install cheshire-cat-api

Luego importe el paquete:

 import cheshire_cat_api as ccat

Interactuar con los puntos finales HTTP

API disponibles

El CatClient tiene los siguientes atributos para interactuar fácilmente con las API relacionadas:

• memoria
• complementos
• conejo
• estado
• incrustación
• ajustes
• LLM

Instanciar conexión

 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 de complementos: recuperar complementos

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

API Rabbithole: sube una 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 )

Enviar un mensaje de 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 ()

Documentación para la configuración

Ambas clases están disponibles con:

 from cheshire_cat_api import Config

Clase	Nombre	Por defecto	Descripción
Configuración	base_url	"Localhost"	URL base donde está alojado el gato
Configuración	port	1865	puerto para la conexión
Configuración	user_id	"usuario"	ID del cliente
Configuración	auth_key	"	Clave de autenticación para los puntos finales HTTP
Configuración	secure_connection	FALSO	si se utiliza un protocolo seguro

API de bajo nivel

Para un uso más avanzado, puede interactuar directamente con el cliente generado automático. Para la documentación, ver aquí