Trainkore SDK

Features

Create chat prompts.
Retrieve chat prompts by ID.
Fetch logs by project ID.
Fetch logs by log ID.

Installation

You can install the Trainkore SDK via npm:

npm install trainkore

Usage

Initialize Trainkore SDK

To start using the SDK, you need to initialize it with your API key. The API key can be found on the Trainkore platform. Here we are using a service class to manage the Trainkore instance.

import Trainkore from "trainkore";
 
class TrainkoreService {
  private trainkore: Trainkore;
 
  constructor(apiKey: string) {
    this.trainkore = new Trainkore(apiKey);
  }
 
  // Method to create a chat prompt
  async createChatPrompt() {
    try {
      const chatPrompt = await this.trainkore.chatPrompt.create({
        projId: "your-project-id",  // Replace with your project ID
        versionId: "your-version-id",  // Replace with your version ID
        userId: "your-user-id",  // Replace with your user ID
        userInput: {
          userInput: {
            "1": "write an email on taking leave from office",
            "2": "Write an essay on {{topic}}",
            "3": "Tell me more about {{movie_name}}"
          },
          selectedOptions: {
            "1": { value: "user", label: "user" },
            "2": { value: "user", label: "user" },
            "3": { value: "user", label: "user" }
          },
          inputValue: {
            topic: "dhoni",
            movie_name: "My Name is Khan"
          },
          imageCards: {}
        },
        userInputData: {
          userInputData: {
            "1": "Who is lord Ram?",
            "2": "Who is Aamir khan?",
            "3": "Write python code to get maximum number in an array"
          },
          selectedOptionsData: {
            "1": { value: "user", label: "user" },
            "2": { value: "user", label: "user" },
            "3": { value: "human", label: "user" }
          }
        },
        parametersValue: {
          stopSliderValue: 50,
          topP: 0.1,
          temperature: 0.3,
          max_tokens: 150,
          frequency_penalty: 0.1,
          presence_penalty: 0.1,
          model: { value: "custom_model", label: "custom_model" }
        }
      });
 
      console.log("Chat Prompt Created:", chatPrompt);
      return chatPrompt;
    } catch (error: any) {
      console.error("Error creating chat prompt:", error.message);
      throw error;
    }
  }
}
 
// Example usage
const apiKey = 'your-api-key-here';  // Replace with your actual API key
const service = new TrainkoreService(apiKey);
 
(async () => {
  try {
    await service.createChatPrompt();
  } catch (error: any) {
    console.error("Error occurred:", error.message);
  }
})();

Retrieve a Chat Prompt by ID

You can retrieve a specific chat prompt by its ID using the getChatPromptById method.

 
(async () => {
  try {
    const chatId = 'your-chat-id'; // Replace with your chat prompt ID(You'll find in app)
    const chatPrompt = await trainkore.chatPrompt.getChatPromptById(chatId);
    console.log('Retrieved Chat Prompt:', chatPrompt);
  } catch (error) {
    console.error('Error retrieving chat prompt:', error.message);
  }
})();

Fetch Logs by Project ID

To fetch logs associated with a project by its projId, use the getLogsByProjectId method.

 
(async () => {
  try {
    const projId = 'your-project-id';  // Replace with your project ID("You'll find in app")
    const logs = await trainkore.log.getLogsByProjectId(projId);
    console.log('Project Logs:', logs);
  } catch (error) {
    console.error('Error fetching logs:', error.message);
  }
})();

Fetch Log by Log ID

To retrieve a specific log by logId, use the getLogByLogId method.

 
(async () => {
  try {
    const logId = 'your-log-id';  // Replace with your log ID(You'll find in app)
    const log = await trainkore.log.getLogByLogId(logId);
    console.log('Log Details:', log);
  } catch (error) {
    console.error('Error fetching log:', error.message);
  }
})();

Contributing

Contributions are welcome! Please submit a pull request or file an issue if you encounter any problems.