@agentica/core/lib/functional/validateHttpController.d.ts

Agentic AI Library specialized in LLM Function Calling

import type { IHttpConnection, IHttpLlmApplication, IHttpLlmFunction, IHttpResponse, ILlmSchema, IValidation, OpenApiV3, OpenApiV3_1, SwaggerV2 } from "@samchon/openapi";
import { OpenApi } from "@samchon/openapi";
import type { IAgenticaController } from "../structures/IAgenticaController";
/**
 * Create an HTTP controller with type validation.
 *
 * Create an {@link IAgenticaController.IHttp} instance which represents
 * the HTTP controller from the given Swagger/OpenAPI document and the
 * target LLM model with connection information.
 *
 * By the way, even though this `validateHttpController` function
 * supports every version of Swagger/OpenAPI specification, there can
 * be a type error in the given document. In that case, the function
 * will return {@link IValidation.IFailure} instance with detailed
 * type error tracing information.
 *
 * @param props Properties to create the HTTP controller instance
 * @returns Validation result of the HTTP controller composition
 * @author Samchon
 */
export declare function validateHttpController<Model extends ILlmSchema.Model>(props: {
    /**
     * Name of the controller.
     */
    name: string;
    /**
     * Target LLM model.
     */
    model: Model;
    /**
     * Swagger/OpenAPI document.
     */
    document: SwaggerV2.IDocument | OpenApiV3.IDocument | OpenApiV3_1.IDocument | OpenApi.IDocument | unknown;
    /**
     * Connection to the server.
     *
     * Connection to the API server including the URL and headers.
     */
    connection: IHttpConnection;
    /**
     * Options for the LLM function calling schema composition.
     */
    options?: Partial<IHttpLlmApplication.IOptions<Model>>;
    /**
     * Executor of the API function.
     *
     * @param props Properties of the API function call
     * @returns HTTP response of the API function call
     */
    execute?: (props: {
        /**
         * Connection to the server.
         */
        connection: IHttpConnection;
        /**
         * Application schema.
         */
        application: IHttpLlmApplication<Model>;
        /**
         * Function schema.
         */
        function: IHttpLlmFunction<Model>;
        /**
         * Arguments of the function calling.
         *
         * It is an object of key-value pairs of the API function's parameters.
         * The property keys are composed by below rules:
         *
         * - parameter names
         * - query parameter as an object type if exists
         * - body parameter if exists
         */
        arguments: object;
    }) => Promise<IHttpResponse>;
}): IValidation<IAgenticaController.IHttp<Model>>;