api client py

Klien API Kucing Cheshire

API untuk mengembangkan klien Python untuk berinteraksi dengan Cheshire Cat.

Paket ini memungkinkan instantiasi klien WebSocket dan menyediakan API untuk berinteraksi dengan semua titik akhir.

Bagian dari paket Python ini secara otomatis dihasilkan oleh Proyek Generator OpenAPI.

Untuk dokumentasi yang lebih dalam tentang titik akhir yang tersedia, silakan merujuk ke API REDOC. Dokumentasi resmi Cheshire Cat tersedia di sini.

Persyaratan.

Python 3.10

Instalasi & Penggunaan

Pip Instal

Anda dapat menginstal API dengan pip :

pip install cheshire-cat-api

Kemudian impor paket:

 import cheshire_cat_api as ccat

Berinteraksi dengan titik akhir HTTP

API yang tersedia

CatClient memiliki atribut berikut untuk dengan mudah berinteraksi dengan API terkait:

• ingatan
• plugin
• Rabbit_hole
• status
• Embedder
• Pengaturan
• llm

Koneksi instantiate

 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
)

Plugin API - Ambil Plugin

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

Rabbithole API - Unggah 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 )

Kirim pesan 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 ()

Dokumentasi untuk konfigurasi

Kedua kelas tersedia dengan:

 from cheshire_cat_api import Config

Kelas	Nama	Bawaan	Keterangan
Konfigurasi	base_url	"Localhost"	url dasar di mana kucing di -host
Konfigurasi	port	1865	Port untuk koneksi
Konfigurasi	user_id	"pengguna"	ID klien
Konfigurasi	auth_key	""	Kunci otentikasi untuk titik akhir HTTP
Konfigurasi	secure_connection	PALSU	Jika menggunakan protokol yang aman

API tingkat rendah

Untuk penggunaan yang lebih maju, Anda dapat langsung berinteraksi dengan klien yang dihasilkan otomatis. Untuk dokumentasi, lihat di sini