Skip to content

cheshire-cat-java-client

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

cheshire-cat-java-client

README.md

cheshire-cat-java-client

😸 Cheshire-Cat API

  • API version: 1.9.2

  • Generator version: 7.13.0

Production ready AI assistant framework

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>it.baccan</groupId>
  <artifactId>cheshire-cat-java-client</artifactId>
  <version>1.9.2</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'cheshire-cat-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'cheshire-cat-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "it.baccan:cheshire-cat-java-client:1.9.2"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/cheshire-cat-java-client-1.9.2.jar
  • target/lib/*.jar

Usage

To add a HTTP proxy for the API client, use ClientConfig:

import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import it.baccan.cheshirecat.*;
import it.baccan.cheshirecat.service.AuthHandlerApi;

...

ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);

AuthHandlerApi apiInstance = new AuthHandlerApi(defaultClient);

Getting Started

Please follow the installation instruction and execute the following Java code:

import it.baccan.cheshirecat.*;
import it.baccan.cheshirecat.auth.*;
import it.baccan.cheshirecat.model.*;
import it.baccan.cheshirecat.service.AuthHandlerApi;

public class AuthHandlerApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        AuthHandlerApi apiInstance = new AuthHandlerApi(defaultClient);
        String authHandlerName = "authHandlerName_example"; // String | 
        try {
            Object result = apiInstance.getAuthHandlerSetting(authHandlerName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthHandlerApi#getAuthHandlerSetting");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AuthHandlerApi getAuthHandlerSetting GET /auth_handler/settings/{auth_handler_name} Get Auth Handler Setting
AuthHandlerApi getAuthHandlerSettings GET /auth_handler/settings Get Auth Handler Settings
AuthHandlerApi upsertAuthenticatorSetting PUT /auth_handler/settings/{auth_handler_name} Upsert Authenticator Setting
EmbedderApi getEmbedderSettings GET /embedder/settings/{languageEmbedderName} Get Embedder Settings
EmbedderApi getEmbeddersSettings GET /embedder/settings Get Embedders Settings
EmbedderApi upsertEmbedderSetting PUT /embedder/settings/{languageEmbedderName} Upsert Embedder Setting
HomeApi messageWithCat POST /message Message With Cat
HomeApi status GET / Status
LargeLanguageModelApi getLlmSettings GET /llm/settings/{languageModelName} Get Llm Settings
LargeLanguageModelApi getLlmsSettings GET /llm/settings Get Llms Settings
LargeLanguageModelApi upsertLlmSetting PUT /llm/settings/{languageModelName} Upsert Llm Setting
PluginsApi deletePlugin DELETE /plugins/{plugin_id} Delete Plugin
PluginsApi getAvailablePlugins GET /plugins/ Get Available Plugins
PluginsApi getPluginDetails GET /plugins/{plugin_id} Get Plugin Details
PluginsApi getPluginSettings GET /plugins/settings/{plugin_id} Get Plugin Settings
PluginsApi getPluginsSettings GET /plugins/settings Get Plugins Settings
PluginsApi installPlugin POST /plugins/upload Install Plugin
PluginsApi installPluginFromRegistry POST /plugins/upload/registry Install Plugin From Registry
PluginsApi togglePlugin PUT /plugins/toggle/{plugin_id} Toggle Plugin
PluginsApi upsertPluginSettings PUT /plugins/settings/{plugin_id} Upsert Plugin Settings
RabbitHoleApi getAllowedMimetypes GET /rabbithole/allowed-mimetypes Get Allowed Mimetypes
RabbitHoleApi uploadFile POST /rabbithole/ Upload File
RabbitHoleApi uploadFiles POST /rabbithole/batch Upload Files
RabbitHoleApi uploadMemory POST /rabbithole/memory Upload Memory
RabbitHoleApi uploadUrl POST /rabbithole/web Upload Url
SettingsApi createSetting POST /settings/ Create Setting
SettingsApi deleteSetting DELETE /settings/{settingId} Delete Setting
SettingsApi getSetting GET /settings/{settingId} Get Setting
SettingsApi getSettings GET /settings/ Get Settings
SettingsApi updateSetting PUT /settings/{settingId} Update Setting
UserAuthApi authToken POST /auth/token Auth Token
UserAuthApi getAvailablePermissions GET /auth/available-permissions Get Available Permissions
UsersApi createUser POST /users/ Create User
UsersApi deleteUser DELETE /users/{user_id} Delete User
UsersApi readUser GET /users/{user_id} Read User
UsersApi readUsers GET /users/ Read Users
UsersApi updateUser PUT /users/{user_id} Update User
VectorMemoryCollectionsApi getCollections GET /memory/collections Get Collections
VectorMemoryCollectionsApi wipeCollections DELETE /memory/collections Wipe Collections
VectorMemoryCollectionsApi wipeSingleCollection DELETE /memory/collections/{collection_id} Wipe Single Collection
VectorMemoryPointsApi createMemoryPoint POST /memory/collections/{collection_id}/points Create Memory Point
VectorMemoryPointsApi deleteMemoryPoint DELETE /memory/collections/{collection_id}/points/{point_id} Delete Memory Point
VectorMemoryPointsApi deleteMemoryPointsByMetadata DELETE /memory/collections/{collection_id}/points Delete Memory Points By Metadata
VectorMemoryPointsApi editMemoryPoint PUT /memory/collections/{collection_id}/points/{point_id} Edit Memory Point
VectorMemoryPointsApi getPointsInCollection GET /memory/collections/{collection_id}/points Get Points In Collection
VectorMemoryPointsApi recallMemoryPoints POST /memory/recall Recall Memory Points
VectorMemoryPointsApi recallMemoryPointsFromText GET /memory/recall Recall Memory Points From Text
WorkingMemoryCurrentConversationApi getConversationHistory GET /memory/conversation_history Get Conversation History
WorkingMemoryCurrentConversationApi wipeConversationHistory DELETE /memory/conversation_history Wipe Conversation History

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author