@promptbook/remote-server/umd/src/execution/AvailableModel.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

import type { ModelVariant } from '../types/ModelVariant';
import type { number_usd } from '../types/number_usd';
import type { string_model_name } from '../types/string_model_name';
import type { string_model_description } from '../types/string_persona_description';
import type { string_title } from '../types/string_title';
import type { string_url } from '../types/string_url';
/**
 * Represents a model that can be used for prompt execution
 */
export type AvailableModel = {
    /**
     * The model title, when not provided, the `modelName` should be used
     *
     * @example "GPT o1"
     */
    readonly modelTitle?: string_title;
    /**
     * The model name aviailable
     *
     * @example "o1"
     */
    readonly modelName: string_model_name;
    /**
     * Variant of the model
     *
     * @example "CHAT"
     */
    readonly modelVariant: ModelVariant;
    /**
     * Unstructured description of the model
     *
     * This will be used to pick the best available model for each task
     *
     * @example "Model with 1 billion parameters and advanced reasoning capabilities"
     */
    readonly modelDescription?: string_model_description;
    /**
     * Pricing information for the model
     */
    readonly pricing?: {
        readonly prompt: number_usd;
        readonly output: number_usd;
    };
    /**
     * URL to the model (or provider) documentation
     */
    readonly documentationUrl?: string_url;
    /**
     * If the model is deprecated, it should not be used for new tasks
     */
    readonly isDeprecated?: boolean;
};