0.12.1 • Published 5 months ago

ccat-api v0.12.1

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

Cheshire Cat AI API Client

API Client made in TypeScript to communicate with the Cheshire Cat AI.\ The package provides a class to interface with the Cheshire Cat AI backend.\ It can be used both in Browser and NodeJS environments.

Every endpoint is a CancelablePromise, which means you can cancel the request if you want.

Installation

npm i ccat-api
# OR
yarn add ccat-api
# OR
pnpm i ccat-api
# OR
bun i ccat-api

Getting started

To set up the client, you must first import the CatClient class:

import { CatClient } from 'ccat-api'

const cat = new CatClient({
    host: 'localhost',
    userId: 'user',
    //... other settings
})

cat.send('Hello from a user!') // this will send a message to the /ws/user

cat.userId = 'new_user'

cat.send('Hello from a new user!') // this will send a message to the /ws/new_user

Client settings

CCAT_API_KEY, CCAT_CORE_HOST, CCAT_CORE_PORT and CCAT_CORE_USE_SECURE_PROTOCOLS refer to the CCAT Core .env file.

PropertyTypeDefaultDescription
hoststringRequiredThe same of CCAT_CORE_HOST
credentialstringundefinedThe same of CCAT_API_KEY or the JWT token
portnumber1865The same of the CCAT_CORE_PORT
securebooleanfalseThe same of the CCAT_CORE_USE_SECURE_PROTOCOLS
userstring'user'The user ID to use for the WebSocket and the API client
instantbooleantrueInstantly initialize the WebSocket and the API client, or later with .init()
timeoutnumber10000Timeout for the endpoints, in milliseconds
wsstringundefinedAn object of type WebSocketSettings

WebSocket settings

PropertyTypeDefaultDescription
retriesnumber3The maximum number of retries before calling onFailed
delaynumber3000The delay for reconnect, in milliseconds
onFailedfunctionundefinedThe function to call after failing all the retries

Then, for example, you can configure the LLM like this:

cat.api.llm.upsertLlmSetting('LLMOpenAIConfig', {
    openai_api_key: 'OPEN_API_KEY'
})

To send a message to the cat, you can:

cat.send('Hello my friend!')

You can listen to the WebSocket events:

cat.onConnected(() => {
    console.log('Socket connected')
}).onMessage(msg => {
    console.log(msg)
}).onError((err, e) => {
    console.error(err, e)
}).onDisconnected(() => {
    console.log('Socket disconnected')
})

For example, you can get the list of plugins like this:

cat.api.plugins.listAvailablePlugins().then(plugins => {
    console.log(plugins)
})

Credits

Made for the Cheshire Cat AI organization.

This was possible thanks to openapi-typescript-codegen.

0.12.0

6 months ago

0.12.1

5 months ago

0.11.3

9 months ago

0.11.1

9 months ago

0.11.2

9 months ago

0.11.0

12 months ago

0.10.4

1 year ago

0.10.5

1 year ago

0.10.6

1 year ago

0.10.3

1 year ago

0.10.2

1 year ago

0.10.1

1 year ago

0.10.0

1 year ago

0.9.3

1 year ago

0.9.2

1 year ago

0.9.1

1 year ago

0.9.0

2 years ago

0.8.1

2 years ago

0.7.2

2 years ago

0.4.5

2 years ago

0.8.0

2 years ago

0.7.1

2 years ago

0.6.2

2 years ago

0.4.4

2 years ago

0.7.3

2 years ago

0.5.0

2 years ago

0.7.0

2 years ago

0.6.1

2 years ago

0.6.0

2 years ago

0.5.1

2 years ago

0.4.3

2 years ago

0.4.2

2 years ago

0.4.1

2 years ago

0.4.0

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.3

2 years ago

0.2.2

2 years ago

0.2.1

2 years ago

0.2.0

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago