@autobe/agent/src/structures/IAutoBeVendor.ts

AI backend server code generator

import OpenAI from "openai";

/**
 * LLM service vendor for Agentica Chat.
 *
 * `IAgenticaVendor` is a type represents an LLM (Large Language Model) vendor
 * of the {@link AutoBeAgent}.
 *
 * Currently, {@link AutoBeAgent} supports OpenAI SDK. However, it does not mean
 * that you can use only OpenAI's GPT model in the {@link AutoBeAgent}. The
 * OpenAI SDK is just a connection tool to the LLM vendor's API, and you can use
 * other LLM vendors by configuring its `baseURL` and API key.
 *
 * Therefore, if you want to use another LLM vendor like Claude or Gemini,
 * please configure the `baseURL` to the {@link api}, and set
 * {@link IAutoBeProps.model schema model} as "cluade" or "gemini".
 *
 * @author Samchon
 */
export interface IAutoBeVendor {
  /** OpenAI API instance. */
  api: OpenAI;

  /**
   * Chat model to be used.
   *
   * `({}) & string` means to support third party hosting cloud(eg. openRouter,
   * aws)
   */
  model: OpenAI.ChatModel | ({} & string);

  /** Options for the request. */
  options?: OpenAI.RequestOptions | undefined;

  /**
   * Number of concurrent requests allowed.
   *
   * If you configure this property, {@link AutoBeAgent} will constrain the
   * number of concurrent requests to the LLM vendor. If you want to share the
   * semaphore instance with other agents, you can directly assign the
   * {@link Semaphore} instance to this property.
   *
   * Otherwise, it will not limit the number of concurrent requests, and the
   * {@link AutoBeAgent} will send requests asynchronously without any limit.
   *
   * @default 16
   */
  semaphore?: number | undefined;
}