api client py

Cheshire Cat API 클라이언트

Cheshire Cat과 상호 작용하기 위해 Python 클라이언트를 개발하는 API.

패키지를 통해 WebSocket 클라이언트를 인스턴스화 할 수 있으며 API가 모든 엔드 포인트와 상호 작용할 수 있습니다.

이 파이썬 패키지의 일부는 OpenAPI Generator 프로젝트에 의해 자동으로 생성됩니다.

사용 가능한 엔드 포인트에 대한 더 깊은 문서는 API Redoc을 참조하십시오. 공식 Cheshire Cat 문서는 여기에서 제공됩니다.

요구 사항.

파이썬 3.10

설치 및 사용

PIP 설치

pip 로 API를 설치할 수 있습니다.

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	"로컬 호스트"	고양이가 호스팅되는 기본 URL
구성	port	1865	연결을위한 포트
구성	user_id	"사용자"	클라이언트의 ID
구성	auth_key	"" "	HTTP 엔드 포인트의 인증 키
구성	secure_connection	거짓	보안 프로토콜을 사용하는 경우

저수준 API

보다 고급 사용을 위해 자동 생성 클라이언트와 직접 상호 작용할 수 있습니다. 문서는 여기를 참조하십시오