@llumiverse/core 0.17.0 → 0.19.0

package/src/types.ts

@@ -1,405 +0,0 @@
-import { PromptFormatter } from './formatters/index.js';
-import { JSONObject } from './json.js';
-import { TextFallbackOptions } from './options.js';
-import { BedrockOptions } from './options/bedrock.js';
-import { OpenAiOptions } from './options/openai.js';
-import { VertexAIOptions } from './options/vertexai.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;
-}
-
-//ResultT should be either JSONObject or string
-//Internal structure used in driver implementation.
-export interface CompletionChunkObject<ResultT = any> {
-    result: ResultT;
-    token_usage?: ExecutionTokenUsage;
-    finish_reason?: "stop" | "length" | string;
-}
-
-//Internal structure used in driver implementation.
-export type CompletionChunk = CompletionChunkObject | string;
-
-export interface ToolDefinition {
-    name: string,
-    description?: string,
-    input_schema: {
-        type: 'object';
-        properties?: unknown | null | undefined;
-        [k: string]: unknown;
-    },
-}
-/**
- * A tool use instance represents a call to a tool.
- * The id property is used to identify the tool call.
- */
-export interface ToolUse<ParamsT = JSONObject> {
-    id: string,
-    tool_name: string,
-    tool_input: ParamsT | null
-}
-
-//ResultT should be either JSONObject or string
-export interface Completion<ResultT = any> {
-    // the driver impl must return the result and optionally the token_usage. the execution time is computed by the extended abstract driver
-    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 type JSONSchema4TypeName =
-    | "string" //
-    | "number"
-    | "integer"
-    | "boolean"
-    | "object"
-    | "array"
-    | "null"
-    | "any";
-
-export interface JSONSchema {
-    type?: JSONSchema4TypeName | JSONSchema4TypeName[];
-    description?: string;
-    properties?: Record<string, JSONSchema>;
-    required?: string[];
-    [k: string]: any;
-}
-
-//Options are split into PromptOptions, ModelOptions and ExecutionOptions.
-//ExecutionOptions are most often used within llumiverse as they are the most complete.
-//The base types are useful for external code that needs to interact with llumiverse.
-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?: JSONSchema;
-}
-
-export interface StatelessExecutionOptions 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;
-}
-
-export interface ExecutionOptions extends StatelessExecutionOptions {
-    /**
-     * 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;
-}
-
-//Common names to share between different models
-export enum SharedOptions {
-    //Text
-    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",
-
-    //Image
-    seed = "seed",
-    number_of_images = "number_of_images",
-}
-
-export enum OptionType {
-    numeric = "numeric",
-    enum = "enum",
-    boolean = "boolean",
-    string_list = "string_list"
-}
-
-// ============== Model Options ===============
-
-export type ModelOptions = TextFallbackOptions | VertexAIOptions | BedrockOptions | OpenAiOptions;
-
-// ============== Option Info ===============
-
-export interface ModelOptionsInfo {
-    options: ModelOptionInfoItem[];
-    _option_id: string; //Should follow same ids as ModelOptions
-}
-
-export type ModelOptionInfoItem = NumericOptionInfo | EnumOptionInfo | BooleanOptionInfo | StringListOptionInfo;
-interface OptionInfoPrototype {
-    type: OptionType;
-    name: string;
-    description?: string;
-
-    //If this is true, whether other options apply is dependent on this option
-    //Therefore, if this option is changed, the set of available options should be refreshed.
-    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[];
-}
-
-// ============== Prompts ===============
-export 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 enum Modalities {
-    text = "text",
-    image = "image",
-}
-
-
-// ============== AI MODEL ==============
-
-export interface AIModel<ProviderKeys = string> {
-    id: string; //id of the model known by the provider
-    name: string; //human readable name
-    provider: ProviderKeys; //provider name
-    description?: string;
-    version?: string; //if any version is specified
-    type?: ModelType; //type of the model
-    tags?: string[]; //tags for searching
-    owner?: string; //owner of the model
-    status?: AIModelStatus; //status of the model
-    can_stream?: boolean; //if the model's reponse can be streamed
-    is_custom?: boolean; //if the model is a custom model (a trained model)
-    is_multimodal?: boolean //if the model support files and images
-    input_modalities?: string[]; //if the model support files and images
-    environment?: string; //the environment name
-}
-
-export 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 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"
-}
-
-
-// ============== training =====================
-
-
-
-export interface DataSource {
-    name: string;
-    mime_type?: string;
-    getStream(): Promise<ReadableStream<Uint8Array | string>>;
-    getURL(): Promise<string>;
-}
-
-export interface TrainingOptions {
-    name: string; // the new model name
-    model: string; // the model to train
-    params?: JSONObject; // the training parameters
-}
-
-export interface TrainingPromptOptions {
-    segments: PromptSegment[];
-    completion: string | JSONObject;
-    model: string; // the model to train
-    schema?: JSONSchema; // the resuilt schema f any
-}
-
-export enum TrainingJobStatus {
-    running = "running",
-    succeeded = "succeeded",
-    failed = "failed",
-    cancelled = "cancelled",
-}
-
-export interface TrainingJob {
-    id: string; // id of the training job
-    status: TrainingJobStatus; // status of the training job - depends on the implementation
-    details?: string;
-    model?: string; // the name of the fine tuned model which is created
-}