api client py

CHESHIRE CAT API Клиент

API для разработки клиентов Python для взаимодействия с Cheshire Cat.

Пакет позволяет создавать создание клиента WebSocket и предоставляет API взаимодействовать со всеми конечными точками.

Часть этого пакета Python автоматически генерируется проектом Generator OpenAPI.

Для более глубокой документации о доступных конечных точках, пожалуйста, обратитесь к API Redoc. Официальная документация «Чеширская кошка» доступна здесь.

Требования.

Python 3.10

Установка и использование

PIP установка

Вы можете установить API с pip :

pip install cheshire-cat-api

Затем импортируйте пакет:

 import cheshire_cat_api as ccat

Взаимодействовать с конечными точками HTTP

Доступные API

CatClient имеет следующие атрибуты, чтобы легко взаимодействовать с соответствующими API:

• память
• плагины
• Rabbit_hole
• статус
• встраивание
• настройки
• LLM

Экземпляр подключения

 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 - извлечь плагины

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

Rabbithole API - загрузите 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 )

Отправить сообщение 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 ()

Документация для конфигурации

Оба класса доступны с:

 from cheshire_cat_api import Config

Сорт	Имя	По умолчанию	Описание
Конфигурация	base_url	"Localhost"	базовый URL, где находится кошка
Конфигурация	port	1865	порт для подключения
Конфигурация	user_id	"пользователь"	удостоверение личности клиента
Конфигурация	auth_key	""	Ключ аутентификации для конечных точек HTTP
Конфигурация	secure_connection	ЛОЖЬ	Если использовать безопасный протокол

Низкоуровневый API

Для более продвинутого использования вы можете напрямую взаимодействовать с клиентом, сгенерированным автоматически. Для документации см. Здесь