@agentica/core/lib/structures/IAgenticaConfig.d.ts

Agentic AI Library specialized in LLM Function Calling

import type { ILlmSchema } from "@samchon/openapi";
import type { AgenticaContext } from "../context/AgenticaContext";
import type { IAgenticaExecutor } from "./IAgenticaExecutor";
import type { IAgenticaSystemPrompt } from "./IAgenticaSystemPrompt";
/**
 * Configuration for Agentic Agent.
 *
 * `IAgenticaConfig` is an interface that defines the configuration
 * properties of the {@link Agentica}. With this configuration, you
 * can set the user's {@link locale}, {@link timezone}, and some of
 * {@link systemPrompt system prompts}.
 *
 * Also, you can affect to the LLM function selecing/calling logic by
 * configuring additional properties. For an example, if you configure the
 * {@link capacity} property, the AI chatbot will divide the functions
 * into the several groups with the configured capacity and select proper
 * functions to call by operating the multiple LLM function selecting
 * agents parallelly.
 *
 * @author Samchon
 */
export interface IAgenticaConfig<Model extends ILlmSchema.Model> {
    /**
     * Agent executor.
     *
     * Executor function of Agentic AI's iteration plan to internal agents
     * running by the {@link Agentica.conversate} function.
     *
     * If you want to customize the agent execution plan, you can do it
     * by assigning you logic function of entire or partial to this property.
     * When customizing it, it would better to reference the
     * {@link ChatGptAgent.execute} function.
     *
     * @param ctx Context of the agent
     * @default ChatGptAgent.execute
     */
    executor?: Partial<IAgenticaExecutor<Model>> | ((ctx: AgenticaContext<Model>) => Promise<void>);
    /**
     * System prompt messages.
     *
     * System prompt messages if you want to customize the system prompt
     * messages for each situation.
     */
    systemPrompt?: IAgenticaSystemPrompt<Model>;
    /**
     * Locale of the A.I. chatbot.
     *
     * If you configure this property, the A.I. chatbot will conversate with
     * the given locale. You can get the locale value by
     *
     * - Browser: `navigator.language`
     * - NodeJS: `process.env.LANG.split(".")[0]`
     *
     * @default your_locale
     */
    locale?: string;
    /**
     * Timezone of the A.I. chatbot.
     *
     * If you configure this property, the A.I. chatbot will consider the
     * given timezone. You can get the timezone value by
     * `Intl.DateTimeFormat().resolvedOptions().timeZone`.
     *
     * @default your_timezone
     */
    timezone?: string;
    /**
     * Retry count.
     *
     * If LLM function calling composed arguments are invalid,
     * the A.I. chatbot will retry to call the function with
     * the modified arguments.
     *
     * By the way, if you configure it to 0 or 1, the A.I. chatbot
     * will not retry the LLM function calling for correcting the
     * arguments.
     *
     * @default 3
     */
    retry?: number;
    /**
     * Capacity of the LLM function selecting.
     *
     * When the A.I. chatbot selects a proper function to call, if the
     * number of functions registered in the
     * {@link IAgenticaProps.applications} is too much greater,
     * the A.I. chatbot often fallen into the hallucination.
     *
     * In that case, if you configure this property value, `Agentica`
     * will divide the functions into the several groups with the configured
     * capacity and select proper functions to call by operating the multiple
     * LLM function selecting agents parallelly.
     *
     * @default 100
     */
    capacity?: number;
    /**
     * Eliticism for the LLM function selecting.
     *
     * If you configure {@link capacity}, the A.I. chatbot will complete
     * the candidate functions to call which are selected by the multiple
     * LLM function selecting agents.
     *
     * Otherwise you configure this property as `false`, the A.I. chatbot
     * will not complete the candidate functions to call and just accept
     * every candidate functions to call which are selected by the multiple
     * LLM function selecting agents.
     *
     * @default true
     */
    eliticism?: boolean;
    /**
     * Backoff strategy.
     *
     * If OpenAI SDK fails to connect LLM API Server, this Backoff factor
     * would be used to retry for the next connection.
     *
     * If the function returns `true`, the retry would be stopped.
     * Otherwise, the retry would be continued.
     *
     * @default (props) => throw props.error
     * @returns {number} The number of milliseconds to wait before the next retry
     * @throws {Error} If the function want to stop the retry, you can throw an error
     */
    backoffStrategy?: (props: {
        count: number;
        error: unknown;
    }) => number;
}