okeymeta-ai-sdk/index.d.ts

Official SDK for OkeyMeta AI models, including OkeyAI—Africa's first trained AI. Seamlessly integrate text, image, and conversational AI into any JavaScript project with enterprise-grade reliability and security.

/**
 * Type definitions for okeymeta-ai-sdk
 * OkeyMeta AI SDK: Official SDK for OkeyMeta AI models, including OkeyAI—Africa's first trained AI.
 * https://github.com/okeymeta/okeymeta-ai-sdk
 */

export interface OkeyMetaClientOptions {
  auth_token?: string;
  headers?: Record<string, string>;
  endpoints?: Record<string, string>;
}

export interface TextCompletionParams {
  model?: string;
  input: string;
  contextKey?: string;
  APiKey?: string;
  raw?: boolean;
  stream?: boolean;
  [key: string]: any;
}

export interface ImageToTextParams {
  model?: string;
  input: string;
  imgUrl: string;
  contextKey?: string;
  APiKey?: string;
  deepCognition?: string;
  reasoningFormat?: 'raw' | 'parsed' | 'hidden';
  raw?: boolean;
  stream?: boolean;
  [key: string]: any;
}

export interface ConversationOptions {
  client: OkeyMetaClient;
  model: string;
  contextKey?: string;
}

export interface ConversationResponse {
  response: string;
  API_KEY?: string;
  APiKey?: string;
  [key: string]: any;
}

export interface StreamingResponse {
  chunk: string;
  fullResponse: string;
  done: boolean;
  apiResponse?: any;
}

/**
 * Main OkeyMetaClient class for interacting with OkeyMeta AI models.
 */
export class OkeyMetaClient {
  constructor(options?: OkeyMetaClientOptions);

  /**
   * Generate or complete text using a specified model.
   * Returns only the AI's response string by default. If { raw: true } is passed, returns the full API object.
   * If { stream: true } is passed, returns an async generator that yields streaming responses.
   */
  textCompletion(params: TextCompletionParams & { raw: true }): Promise<ConversationResponse>;
  textCompletion(params: TextCompletionParams & { stream: true }): AsyncGenerator<StreamingResponse>;
  textCompletion(params: TextCompletionParams): Promise<string>;

  /**
   * Generate text from an image using a specified model.
   * Returns only the AI's response string by default. If { raw: true } is passed, returns the full API object.
   * If { stream: true } is passed, returns an async generator that yields streaming responses.
   */
  imageToText(params: ImageToTextParams & { raw: true }): Promise<ConversationResponse>;
  imageToText(params: ImageToTextParams & { stream: true }): AsyncGenerator<StreamingResponse>;
  imageToText(params: ImageToTextParams): Promise<string>;

  /**
   * Start a new conversation with a model.
   */
  startConversation(model?: string, contextKey?: string): Conversation;
}

/**
 * Create a custom OkeyMeta provider instance (advanced usage).
 */
export function createOkeyMetaProvider(options?: OkeyMetaClientOptions): OkeyMetaClient;

/**
 * Conversation manager for multi-turn dialog with OkeyMeta models.
 */
export class Conversation {
  constructor(options: ConversationOptions);

  /**
   * Set or update the context key for the conversation.
   */
  setContextKey(contextKey: string): void;

  /**
   * Send a message and receive a response from the model.
   * Returns only the AI's response string.
   */
  send(input: string, params?: Record<string, any>): Promise<string>;

  /**
   * Send a message and receive a streaming response from the model.
   * Returns an async generator that yields streaming responses.
   */
  sendStream(input: string, params?: Record<string, any>): AsyncGenerator<StreamingResponse>;
}