cloving 0.3.18 → 0.3.19

package/src/cloving_gpt/adapters/claude.ts

@@ -0,0 +1,140 @@
+import { Adapter } from '.'
+import type { GPTRequest, OpenAIStreamChunk } from '../../utils/types'
+
+/**
+ * ClaudeAdapter class implements the Adapter interface for Claude AI models.
+ */
+export class ClaudeAdapter implements Adapter {
+  private model: string
+  private anthropicVersion: string
+
+  /**
+   * Array of supported Claude model identifiers.
+   */
+  static supportedModels: string[] = [
+    'claude:claude-3-5:sonnet-20240620',
+    'claude:claude-3:opus-20240229',
+    'claude:claude-3:sonnet-20240229',
+    'claude:claude-3:haiku-20240307',
+    // Add more supported models here as needed
+  ]
+
+  /**
+   * Initializes a new ClaudeAdapter instance.
+   * @param model - The Claude model identifier.
+   */
+  constructor(model: string) {
+    this.model = model
+    this.anthropicVersion = '2023-06-01'
+  }
+
+  /**
+   * Logs all supported Claude models to the console.
+   */
+  static listSupportedModels(): void {
+    ClaudeAdapter.supportedModels.forEach((model) => {
+      console.log(model)
+    })
+  }
+
+  /**
+   * Returns the API endpoint for Claude.
+   * @returns The API endpoint URL.
+   */
+  getEndpoint(): string {
+    return `https://api.anthropic.com/v1/messages`
+  }
+
+  /**
+   * Generates headers for API requests.
+   * @param apiKey - The API key for authentication.
+   * @returns An object containing the required headers.
+   */
+  getHeaders(apiKey: string): Record<string, string> {
+    return {
+      'x-api-key': apiKey,
+      'Content-Type': 'application/json',
+      'anthropic-version': this.anthropicVersion,
+    }
+  }
+
+  /**
+   * Prepares the payload for API requests.
+   * @param request - The GPTRequest object containing request details.
+   * @param stream - Whether to enable streaming (default: false).
+   * @returns An object containing the prepared payload.
+   */
+  getPayload(request: GPTRequest, stream: boolean = false): Record<string, any> {
+    let system = 'You are a computer programmer giving advice on how to write better code.'
+    if (request.messages && request.messages.length > 0 && request.messages[0].role === 'system') {
+      system = request.messages[0].content
+      request = { ...request, messages: request.messages.slice(1) }
+    }
+    return {
+      model: this.model.replace(':', '-'),
+      system,
+      messages:
+        request.messages && request.messages.length > 0
+          ? request.messages
+          : [{ role: 'user', content: request.prompt }],
+      max_tokens: request.maxTokens || 4096,
+      temperature: request.temperature || 0.2,
+      stream,
+    }
+  }
+
+  /**
+   * Extracts the response text from the API response data.
+   * @param data - The API response data.
+   * @returns The extracted response text.
+   * @throws Error if the response structure is invalid.
+   */
+  extractResponse(data: any): string {
+    try {
+      if (data && data.content && Array.isArray(data.content) && data.content.length > 0) {
+        return data.content.map((item: any) => item.text).join('\n')
+      } else {
+        console.error('Unexpected response structure:', data)
+        throw new Error('Invalid response structure')
+      }
+    } catch (error) {
+      console.error('Error extracting response:', error)
+      throw error
+    }
+  }
+
+  /**
+   * Converts streaming data to OpenAIStreamChunk format.
+   * @param data - The streaming data string.
+   * @returns An OpenAIStreamChunk object or null if parsing fails.
+   */
+  convertStream(data: string): OpenAIStreamChunk | null {
+    let beginningChar = 0
+    let lastChar = 0
+
+    while (lastChar < data.length) {
+      try {
+        let remainingString = data.slice(beginningChar, lastChar)
+
+        // Strip any leading characters until we encounter the first '{' in this block
+        const firstBraceIndex = remainingString.indexOf('{')
+        if (firstBraceIndex > -1) {
+          remainingString = remainingString.slice(firstBraceIndex)
+        }
+
+        const parsedObject = JSON.parse(remainingString)
+        const output = parsedObject?.delta?.text || ''
+
+        return {
+          output,
+          lastChar,
+        }
+      } catch (error) {
+        // Incrementally increase the size of the JSON string to parse
+        lastChar += 1
+      }
+    }
+
+    return null
+  }
+}

package/src/cloving_gpt/adapters/gemini.ts

@@ -0,0 +1,146 @@
+import { Adapter } from '.'
+import type { OpenAIStreamChunk, GPTRequest } from '../../utils/types'
+
+/**
+ * GeminiAdapter class implements the Adapter interface for Google's Gemini AI model.
+ */
+export class GeminiAdapter implements Adapter {
+  private model: string
+
+  static supportedModels: string[] = [
+    'gemini:gemini-1.5:pro-latest',
+    'gemini:gemini-1.5:flash-latest',
+    'gemini:gemini-1.0:pro-latest',
+  ]
+
+  /**
+   * Creates a new GeminiAdapter instance.
+   * @param model - The Gemini model to use.
+   */
+  constructor(model: string) {
+    this.model = model
+  }
+
+  /**
+   * Lists all supported Gemini models to the console.
+   */
+  static async listSupportedModels(): Promise<void> {
+    GeminiAdapter.supportedModels.forEach((model) => {
+      console.log(model)
+    })
+  }
+
+  /**
+   * Gets the appropriate API endpoint URL based on whether streaming is required.
+   * @param stream - Whether to use streaming endpoint.
+   * @returns The API endpoint URL.
+   */
+  getEndpoint(stream: boolean = false): string {
+    if (stream) {
+      return `https://generativelanguage.googleapis.com/v1beta/models/${this.model.replace(':', '-')}:streamGenerateContent`
+    } else {
+      return `https://generativelanguage.googleapis.com/v1beta/models/${this.model.replace(':', '-')}:generateContent`
+    }
+  }
+
+  /**
+   * Generates headers for the API request.
+   * @param apiKey - The API key for authentication.
+   * @returns An object containing the necessary headers.
+   */
+  getHeaders(apiKey: string): Record<string, string> {
+    return {
+      'Content-Type': 'application/json',
+      'x-goog-api-key': apiKey,
+    }
+  }
+
+  /**
+   * Prepares the payload for the API request.
+   * @param request - The GPTRequest object containing prompt and other parameters.
+   * @param stream - Whether the request is for streaming.
+   * @returns The formatted payload object.
+   */
+  getPayload(request: GPTRequest, stream: boolean = false): Record<string, any> {
+    return {
+      contents: [
+        {
+          role: 'user', // or 'model' if generated from the model
+          parts: [
+            {
+              text: request.prompt,
+            },
+          ],
+        },
+      ],
+      generationConfig: {
+        temperature: request.temperature || 0.2,
+        topK: 40,
+        topP: 0.95,
+        maxOutputTokens: 1024,
+      },
+    }
+  }
+
+  /**
+   * Extracts the response text from the API response data.
+   * @param data - The raw API response data.
+   * @returns The extracted response text.
+   * @throws Error if the response structure is invalid.
+   */
+  extractResponse(data: any): string {
+    try {
+      if (
+        data &&
+        data.candidates &&
+        data.candidates[0] &&
+        data.candidates[0].content &&
+        data.candidates[0].content.parts &&
+        data.candidates[0].content.parts[0]
+      ) {
+        return data.candidates[0].content.parts[0].text
+      } else {
+        console.error('Unexpected response structure:', data)
+        throw new Error('Invalid response structure')
+      }
+    } catch (error) {
+      console.error('Error extracting response:', error)
+      throw error
+    }
+  }
+
+  /**
+   * Converts a stream chunk to an OpenAIStreamChunk format.
+   * @param data - The raw stream chunk data.
+   * @returns An OpenAIStreamChunk object or null if parsing fails.
+   */
+  convertStream(data: string): OpenAIStreamChunk | null {
+    let beginningChar = 0
+    let lastChar = 0
+
+    while (lastChar < data.length) {
+      try {
+        let remainingString = data.slice(beginningChar, lastChar)
+
+        // Strip any leading characters until we encounter the first '{' in this block
+        const firstBraceIndex = remainingString.indexOf('{')
+        if (firstBraceIndex > -1) {
+          remainingString = remainingString.slice(firstBraceIndex)
+        }
+
+        const parsedObject = JSON.parse(remainingString)
+        const output = parsedObject?.candidates[0]?.content?.parts[0]?.text || ''
+
+        return {
+          output,
+          lastChar,
+        }
+      } catch (error) {
+        // Incrementally increase the size of the JSON string to parse
+        lastChar += 1
+      }
+    }
+
+    return null
+  }
+}

package/src/cloving_gpt/adapters/index.ts

@@ -0,0 +1,43 @@
+import type { GPTRequest, OpenAIStreamChunk } from '../../utils/types'
+
+/**
+ * Interface defining the structure for GPT adapters.
+ * This interface allows for different implementations of GPT API interactions.
+ */
+export interface Adapter {
+  /**
+   * Determines the appropriate endpoint URL based on whether streaming is enabled.
+   * @param stream - Boolean indicating if streaming is enabled.
+   * @returns The endpoint URL as a string.
+   */
+  getEndpoint(stream: boolean): string
+
+  /**
+   * Generates the necessary headers for the API request.
+   * @param apiKey - The API key for authentication.
+   * @returns An object containing the required headers.
+   */
+  getHeaders(apiKey: string): Record<string, string>
+
+  /**
+   * Prepares the payload for the API request.
+   * @param request - The GPTRequest object containing the request details.
+   * @param stream - Boolean indicating if streaming is enabled.
+   * @returns An object representing the request payload.
+   */
+  getPayload(request: GPTRequest, stream: boolean): Record<string, any>
+
+  /**
+   * Extracts the response from the API data.
+   * @param data - The raw data received from the API.
+   * @returns The extracted response as a string.
+   */
+  extractResponse(data: any): string
+
+  /**
+   * Converts streaming data into an OpenAIStreamChunk object.
+   * @param data - The raw streaming data as a string.
+   * @returns An OpenAIStreamChunk object or null if conversion is not possible.
+   */
+  convertStream(data: string): OpenAIStreamChunk | null
+}

package/src/cloving_gpt/adapters/mistral.ts

@@ -0,0 +1,142 @@
+import { Adapter } from '.'
+import type { OpenAIStreamChunk, GPTRequest } from '../../utils/types'
+
+/**
+ * MistralAdapter class
+ * Implements the Adapter interface for Mistral AI models.
+ */
+export class MistralAdapter implements Adapter {
+  private model: string
+
+  /**
+   * List of supported Mistral AI models
+   */
+  static supportedModels: string[] = [
+    'mistral:mistral:embed',
+    'mistral:mistral:tiny-latest',
+    'mistral:mistral:small-latest',
+    'mistral:mistral:medium-latest',
+    'mistral:mistral:large-latest',
+    'mistral:open-mistral:7b',
+    'mistral:open-mixtral:8x7b',
+    'mistral:open-mixtral:8x22b',
+    'mistral:codestral:latest',
+  ]
+
+  /**
+   * Prints all supported models to the console
+   */
+  static listSupportedModels(): void {
+    MistralAdapter.supportedModels.forEach((model) => {
+      console.log(model)
+    })
+  }
+
+  /**
+   * Constructor
+   * @param model - The Mistral AI model to use
+   */
+  constructor(model: string) {
+    this.model = model
+  }
+
+  /**
+   * @returns The Mistral AI API endpoint
+   */
+  getEndpoint(): string {
+    return 'https://api.mistral.ai/v1/chat/completions'
+  }
+
+  /**
+   * @param apiKey - The API key for authentication
+   * @returns Headers for the API request
+   */
+  getHeaders(apiKey: string): Record<string, string> {
+    return {
+      Authorization: `Bearer ${apiKey}`,
+      'Content-Type': 'application/json',
+    }
+  }
+
+  /**
+   * Prepares the payload for the API request
+   * @param request - The GPT request object
+   * @param stream - Whether to use streaming mode
+   * @returns The formatted payload
+   */
+  getPayload(request: GPTRequest, stream: boolean = false): Record<string, any> {
+    return {
+      model: this.model.replace(':', '-'),
+      messages:
+        request.messages && request.messages.length > 0
+          ? request.messages
+          : [{ role: 'user', content: request.prompt }],
+      max_tokens: request.maxTokens,
+      temperature: request.temperature || 0.2,
+      stream,
+    }
+  }
+
+  /**
+   * Extracts the response content from the API data
+   * @param data - The API response data
+   * @returns The extracted response content
+   */
+  extractResponse(data: any): string {
+    return data.choices[0].message.content
+  }
+
+  // data example:
+  //    {
+  //      id: 'chatcmpl-9tL477A98d54qvVQqJT010bm8BLJl',
+  //      object: 'chat.completion.chunk',
+  //      created: 1722976043,
+  //      model: 'gpt-4o-2024-05-13',
+  //      system_fingerprint: 'fp_3aa7262c27',
+  //      choices: [
+  //          {
+  //            "index": 0,
+  //            "delta": {
+  //              "content": " basic"
+  //            },
+  //            "logprobs": null,
+  //            "finish_reason": null
+  //          }
+  //      ]
+  //    }
+
+  /**
+   * Converts streaming data to OpenAIStreamChunk format
+   * @param data - The streaming data string
+   * @returns Parsed OpenAIStreamChunk or null if parsing fails
+   */
+  convertStream(data: string): OpenAIStreamChunk | null {
+    let beginningChar = 0
+    let lastChar = 0
+
+    while (lastChar < data.length) {
+      try {
+        let remainingString = data.slice(beginningChar, lastChar)
+
+        // Strip any leading characters until we encounter the first '{' in this block
+        const firstBraceIndex = remainingString.indexOf('{')
+        if (firstBraceIndex > -1) {
+          remainingString = remainingString.slice(firstBraceIndex)
+        }
+
+        const parsedObject = JSON.parse(remainingString)
+        const output = parsedObject?.choices[0]?.delta?.content || ''
+
+        return {
+          output,
+          lastChar,
+        }
+      } catch (error) {
+        // Incrementally increase the size of the JSON string to parse
+        lastChar += 1
+      }
+    }
+
+    return null
+  }
+}

package/src/cloving_gpt/adapters/ollama.ts

@@ -0,0 +1,136 @@
+import axios from 'axios'
+
+import { Adapter } from '.'
+import type { OpenAIStreamChunk, GPTRequest } from '../../utils/types'
+
+/**
+ * Adapter for interacting with the Ollama API.
+ */
+export class OllamaAdapter implements Adapter {
+  private model: string
+
+  static supportedModels: string[] = []
+
+  /**
+   * Constructor to initialize the OllamaAdapter with a specific model.
+   * @param model - The model to be used by the adapter.
+   */
+  constructor(model: string) {
+    this.model = model
+  }
+
+  /**
+   * Fetches and lists supported models from the Ollama API.
+   */
+  static async listSupportedModels(): Promise<void> {
+    try {
+      const endpoint = 'http://localhost:11434/api/tags'
+      const headers = {
+        'Content-Type': 'application/json',
+      }
+
+      const response = await axios.get(endpoint, { headers })
+      const data = response.data
+
+      if (data && Array.isArray(data.models)) {
+        OllamaAdapter.supportedModels = data.models.map((model: any) => `ollama:${model.name}`)
+        OllamaAdapter.supportedModels.forEach((model) => {
+          console.log(model)
+        })
+      } else {
+        console.error('Unexpected response structure:', data)
+      }
+    } catch (error) {
+      // do nothing, no ollama server running
+    }
+  }
+
+  /**
+   * Returns the endpoint URL for generating responses.
+   * @returns The endpoint URL as a string.
+   */
+  getEndpoint(): string {
+    return `http://localhost:11434/api/generate`
+  }
+
+  /**
+   * Returns the headers required for making API requests.
+   * @param apiKey - The API key for authorization.
+   * @returns An object containing the headers.
+   */
+  getHeaders(apiKey: string): Record<string, string> {
+    return {
+      Authorization: `Bearer ${apiKey}`,
+      'Content-Type': 'application/json',
+    }
+  }
+
+  /**
+   * Constructs the payload for the API request.
+   * @param request - The GPT request object containing the prompt.
+   * @param stream - Boolean indicating if the response should be streamed.
+   * @returns An object containing the payload.
+   */
+  getPayload(request: GPTRequest, stream: boolean = false): Record<string, any> {
+    return {
+      model: this.model,
+      prompt: request.prompt,
+      stream,
+    }
+  }
+
+  /**
+   * Extracts the response from the API response data.
+   * @param data - The response data from the API.
+   * @returns The extracted response as a string.
+   * @throws Will throw an error if the response structure is invalid.
+   */
+  extractResponse(data: any): string {
+    try {
+      if (data && typeof data === 'object' && 'response' in data) {
+        return data.response
+      } else {
+        console.error('Unexpected response structure:', data)
+        throw new Error('Invalid response structure')
+      }
+    } catch (error) {
+      console.error('Error extracting response:', error)
+      throw error
+    }
+  }
+
+  /**
+   * Converts a stream of data into an OpenAIStreamChunk.
+   * @param data - The string data to be converted.
+   * @returns An OpenAIStreamChunk object or null if conversion fails.
+   */
+  convertStream(data: string): OpenAIStreamChunk | null {
+    let beginningChar = 0
+    let lastChar = 0
+
+    while (lastChar < data.length) {
+      try {
+        let remainingString = data.slice(beginningChar, lastChar)
+
+        // Strip any leading characters until we encounter the first '{' in this block
+        const firstBraceIndex = remainingString.indexOf('{')
+        if (firstBraceIndex > -1) {
+          remainingString = remainingString.slice(firstBraceIndex)
+        }
+
+        const parsedObject = JSON.parse(remainingString)
+        const output = parsedObject?.response || ''
+
+        return {
+          output,
+          lastChar,
+        }
+      } catch (error) {
+        // Incrementally increase the size of the JSON string to parse
+        lastChar += 1
+      }
+    }
+
+    return null
+  }
+}