@llumiverse/core 0.16.0 → 0.18.0

package/lib/types/types.d.ts

@@ -1,308 +0,0 @@
-import { JSONSchema4 } from 'json-schema';
-import { PromptFormatter } from './formatters/index.js';
-import { JSONObject } from './json.js';
-import { TextFallbackOptions } from './options.js';
-import { VertexAIOptions } from './options/vertexai.js';
-import { BedrockOptions } from './options/bedrock.js';
-import { OpenAiOptions } from './options/openai.js';
-export interface EmbeddingsOptions {
-    /**
-     * The text to generate the embeddings for. One of text or image is required.
-     */
-    text?: string;
-    /**
-     * The image to generate embeddings for
-     */
-    image?: string;
-    /**
-     * The model to use to generate the embeddings. Optional.
-     */
-    model?: string;
-}
-export interface EmbeddingsResult {
-    /**
-     * The embedding vectors corresponding to the words in the input text.
-     */
-    values: number[];
-    /**
-     * The model used to hgenerate the embeddings.
-     */
-    model: string;
-    /**
-     * Number of tokens of the input text.
-     */
-    token_count?: number;
-}
-export interface ResultValidationError {
-    code: 'validation_error' | 'json_error' | 'content_policy_violation';
-    message: string;
-    data?: string;
-}
-export interface CompletionChunkObject<ResultT = any> {
-    result: ResultT;
-    token_usage?: ExecutionTokenUsage;
-    finish_reason?: "stop" | "length" | string;
-}
-export type CompletionChunk = CompletionChunkObject | string;
-export interface ToolDefinition {
-    name: string;
-    description?: string;
-    input_schema: {
-        type: 'object';
-        properties?: unknown | null | undefined;
-        [k: string]: unknown;
-    };
-}
-export interface ToolUse {
-    id: string;
-    name: string;
-    input: JSONObject | null;
-}
-export interface Completion<ResultT = any> {
-    result: ResultT;
-    token_usage?: ExecutionTokenUsage;
-    /**
-     * Contains the tools from which the model awaits information.
-     */
-    tool_use?: ToolUse[];
-    /**
-     * The finish reason as reported by the model: stop | length or other model specific values
-     */
-    finish_reason?: "stop" | "length" | "tool_use" | string;
-    /**
-     * Set only if a result validation error occured, otherwise if the result is valid the error field is undefined
-     * This can only be set if the result_schema is set and the reuslt could not be parsed as a json or if the result does not match the schema
-     */
-    error?: ResultValidationError;
-    /**
-     * The original response. Only included if the option include_original_response is set to true and the request is made using execute. Not supported when streaming.
-     */
-    original_response?: Record<string, any>;
-    /**
-     * The conversation context. This is an opaque structure that can be passed to the next request to restore the context.
-     */
-    conversation?: unknown;
-}
-export interface ImageGeneration {
-    images?: string[];
-}
-export interface ExecutionResponse<PromptT = any> extends Completion {
-    prompt: PromptT;
-    /**
-     * The time it took to execute the request in seconds
-     */
-    execution_time?: number;
-    /**
-     * The number of chunks for streamed executions
-     */
-    chunks?: number;
-}
-export interface CompletionStream<PromptT = any> extends AsyncIterable<string> {
-    completion: ExecutionResponse<PromptT> | undefined;
-}
-export interface Logger {
-    debug: (...obj: any[]) => void;
-    info: (...obj: any[]) => void;
-    warn: (...obj: any[]) => void;
-    error: (...obj: any[]) => void;
-}
-export interface DriverOptions {
-    logger?: Logger | "console";
-}
-export interface PromptOptions {
-    model: string;
-    /**
-     * A custom formatter to use for format the final model prompt from the input prompt segments.
-     * If no one is specified the driver will choose a formatter compatible with the target model
-     */
-    format?: PromptFormatter;
-    result_schema?: JSONSchema4;
-}
-export interface ExecutionOptions extends PromptOptions {
-    /**
-     * If set to true the original response from the target LLM will be included in the response under the original_response field.
-     * This is useful for debugging and for some advanced use cases.
-     * It is ignored on streaming requests
-     */
-    include_original_response?: boolean;
-    model_options?: ModelOptions;
-    output_modality: Modalities;
-    /**
-     * Available tools for the request
-     */
-    tools?: ToolDefinition[];
-    /**
-     * This is an opaque structure that provides a conversation context
-     * Each driver implementation will return a conversation property in the execution response
-     * that can be passed here to restore the context when a new prompt is sent to the model.
-     */
-    conversation?: unknown | null;
-}
-export declare enum SharedOptions {
-    max_tokens = "max_tokens",
-    temperature = "temperature",
-    top_p = "top_p",
-    top_k = "top_k",
-    presence_penalty = "presence_penalty",
-    frequency_penalty = "frequency_penalty",
-    stop_sequence = "stop_sequence",
-    seed = "seed",
-    number_of_images = "number_of_images"
-}
-export declare enum OptionType {
-    numeric = "numeric",
-    enum = "enum",
-    boolean = "boolean",
-    string_list = "string_list"
-}
-export type ModelOptions = TextFallbackOptions | VertexAIOptions | BedrockOptions | OpenAiOptions;
-export interface ModelOptionsInfo {
-    options: ModelOptionInfoItem[];
-    _option_id: string;
-}
-export type ModelOptionInfoItem = NumericOptionInfo | EnumOptionInfo | BooleanOptionInfo | StringListOptionInfo;
-interface OptionInfoPrototype {
-    type: OptionType;
-    name: string;
-    description?: string;
-    refresh?: boolean;
-}
-export interface NumericOptionInfo extends OptionInfoPrototype {
-    type: OptionType.numeric;
-    value?: number;
-    min?: number;
-    max?: number;
-    step?: number;
-    integer?: boolean;
-    default?: number;
-}
-export interface EnumOptionInfo extends OptionInfoPrototype {
-    type: OptionType.enum;
-    value?: string;
-    enum: Record<string, string>;
-    default?: string;
-}
-export interface BooleanOptionInfo extends OptionInfoPrototype {
-    type: OptionType.boolean;
-    value?: boolean;
-    default?: boolean;
-}
-export interface StringListOptionInfo extends OptionInfoPrototype {
-    type: OptionType.string_list;
-    value?: string[];
-    default?: string[];
-}
-export declare enum PromptRole {
-    safety = "safety",
-    system = "system",
-    user = "user",
-    assistant = "assistant",
-    negative = "negative",
-    mask = "mask",
-    /**
-     * Used to send the response of a tool
-     */
-    tool = "tool"
-}
-export interface PromptSegment {
-    role: PromptRole;
-    content: string;
-    /**
-     * The tool use id if the segment is a tool response
-     */
-    tool_use_id?: string;
-    files?: DataSource[];
-}
-export interface ExecutionTokenUsage {
-    prompt?: number;
-    result?: number;
-    total?: number;
-}
-export declare enum Modalities {
-    text = "text",
-    image = "image"
-}
-export interface AIModel<ProviderKeys = string> {
-    id: string;
-    name: string;
-    provider: ProviderKeys;
-    description?: string;
-    version?: string;
-    type?: ModelType;
-    tags?: string[];
-    owner?: string;
-    status?: AIModelStatus;
-    can_stream?: boolean;
-    is_custom?: boolean;
-    is_multimodal?: boolean;
-}
-export declare enum AIModelStatus {
-    Available = "available",
-    Pending = "pending",
-    Stopped = "stopped",
-    Unavailable = "unavailable",
-    Unknown = "unknown"
-}
-/**
- * payload to list available models for an enviroment
- * @param environmentId id of the environment
- * @param query text to search for in model name/description
- * @param type type of the model
- * @param tags tags for searching
- */
-export interface ModelSearchPayload {
-    text: string;
-    type?: ModelType;
-    tags?: string[];
-    owner?: string;
-}
-export declare enum ModelType {
-    Classifier = "classifier",
-    Regressor = "regressor",
-    Clustering = "clustering",
-    AnomalyDetection = "anomaly-detection",
-    TimeSeries = "time-series",
-    Text = "text",
-    Image = "image",
-    Audio = "audio",
-    Video = "video",
-    Embedding = "embedding",
-    Chat = "chat",
-    Code = "code",
-    NLP = "nlp",
-    MultiModal = "multi-modal",
-    Test = "test",
-    Other = "other",
-    Unknown = "unknown"
-}
-export interface DataSource {
-    name: string;
-    mime_type?: string;
-    getStream(): Promise<ReadableStream<Uint8Array | string>>;
-    getURL(): Promise<string>;
-}
-export interface TrainingOptions {
-    name: string;
-    model: string;
-    params?: JSONObject;
-}
-export interface TrainingPromptOptions {
-    segments: PromptSegment[];
-    completion: string | JSONObject;
-    model: string;
-    schema?: JSONSchema4;
-}
-export declare enum TrainingJobStatus {
-    running = "running",
-    succeeded = "succeeded",
-    failed = "failed",
-    cancelled = "cancelled"
-}
-export interface TrainingJob {
-    id: string;
-    status: TrainingJobStatus;
-    details?: string;
-    model?: string;
-}
-export {};
-//# sourceMappingURL=types.d.ts.map

package/lib/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,WAAW,iBAAiB;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAElB;AAED,MAAM,WAAW,gBAAgB;IAC7B;;OAEG;IACH,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CAExB;AAED,MAAM,WAAW,qBAAqB;IAClC,IAAI,EAAE,kBAAkB,GAAG,YAAY,GAAG,0BAA0B,CAAC;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAID,MAAM,WAAW,qBAAqB,CAAC,OAAO,GAAG,GAAG;IAChD,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,MAAM,CAAC;CAC9C;AAGD,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,MAAM,CAAC;AAE7D,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE;QACV,IAAI,EAAE,QAAQ,CAAC;QACf,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;QACxC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACxB,CAAC;CACL;AAED,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;CAC3B;AAGD,MAAM,WAAW,UAAU,CAAC,OAAO,GAAG,GAAG;IAErC,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,mBAAmB,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,MAAM,CAAC;IAExD;;;OAGG;IACH,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAE9B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAExC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAE5B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CAErB;AAED,MAAM,WAAW,iBAAiB,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,UAAU;IAChE,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,WAAW,gBAAgB,CAAC,OAAO,GAAG,GAAG,CAAE,SAAQ,aAAa,CAAC,MAAM,CAAC;IAC1E,UAAU,EAAE,iBAAiB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;CACtD;AAED,MAAM,WAAW,MAAM;IACnB,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC/B,IAAI,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC9B,IAAI,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC9B,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,aAAa;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAKD,MAAM,WAAW,aAAa;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,aAAa,CAAC,EAAE,WAAW,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACnD;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,aAAa,CAAC,EAAE,YAAY,CAAC;IAC7B,eAAe,EAAE,UAAU,CAAC;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAGD,oBAAY,aAAa;IAErB,UAAU,eAAe;IACzB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,KAAK,UAAU;IACf,gBAAgB,qBAAqB;IACrC,iBAAiB,sBAAsB;IACvC,aAAa,kBAAkB;IAG/B,IAAI,SAAS;IACb,gBAAgB,qBAAqB;CACxC;AAED,oBAAY,UAAU;IAClB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,WAAW,gBAAgB;CAC9B;AAID,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,eAAe,GAAG,cAAc,GAAG,aAAa,CAAC;AAIlG,MAAM,WAAW,gBAAgB;IAC7B,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,mBAAmB,GAAG,iBAAiB,GAAG,cAAc,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;AAChH,UAAU,mBAAmB;IACzB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IAIrB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC1D,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAe,SAAQ,mBAAmB;IACvD,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAkB,SAAQ,mBAAmB;IAC1D,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC;IACzB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,IAAI,EAAE,UAAU,CAAC,WAAW,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAGD,oBAAY,UAAU;IAClB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb;;OAEG;IACH,IAAI,SAAS;CAChB;AAED,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,UAAU,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,mBAAmB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,UAAU;IAClB,IAAI,SAAS;IACb,KAAK,UAAU;CAClB;AAKD,MAAM,WAAW,OAAO,CAAC,YAAY,GAAG,MAAM;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,YAAY,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,oBAAY,aAAa;IACrB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,WAAW,gBAAgB;IAC3B,OAAO,YAAY;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAGD,oBAAY,SAAS;IACjB,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,UAAU,eAAe;IACzB,gBAAgB,sBAAsB;IACtC,UAAU,gBAAgB;IAC1B,IAAI,SAAS;IACb,KAAK,UAAU;IACf,KAAK,UAAU;IACf,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,UAAU,gBAAgB;IAC1B,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;CACtB;AAOD,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC;IAC1D,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,UAAU,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IAClC,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB;AAED,oBAAY,iBAAiB;IACzB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,SAAS,cAAc;CAC1B;AAED,MAAM,WAAW,WAAW;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,iBAAiB,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB"}