openlayer 0.0.1-alpha.0 → 0.0.1-alpha.1

package/lib/core/index.d.ts

@@ -1,237 +0,0 @@
-import { RequestOptions } from 'openai/core';
-import { ChatCompletion, ChatCompletionChunk, ChatCompletionCreateParams, ChatCompletionMessageParam, Completion, CompletionCreateParams } from 'openai/resources';
-import { Run } from 'openai/resources/beta/threads/runs/runs';
-import { Stream } from 'openai/streaming';
-/**
- * Represents the data structure for a chat completion.
- * Object keys represent a column name and the values represent the column value.
- */
-export interface StreamingData {
-    [columnName: string]: any;
-    /**
-     * The total estimated cost of the chat completion in USD. Optional.
-     */
-    cost?: number | undefined;
-    /**
-     * The latency of the chat completion in milliseconds. Optional.
-     */
-    latency?: number | undefined;
-    /**
-     * The output string generated by the chat completion.
-     */
-    output: string;
-    /**
-     * A timestamp representing when the chat completion occurred. Optional.
-     */
-    timestamp?: number | undefined;
-    /**
-     * The number of tokens used in the chat completion. Optional.
-     */
-    tokens?: number | undefined;
-}
-/**
- * Configuration settings for uploading chat completion data to Openlayer.
- */
-interface StreamingDataConfig {
-    /**
-     * The name of the column that stores the request cost data. Can be null.
-     */
-    costColumnName: string | null;
-    /**
-     * The name of the column that stores the ground truth data. Can be null.
-     */
-    groundTruthColumnName: string | null;
-    /**
-     * The name of the column that stores inference IDs. Can be null.
-     */
-    inferenceIdColumnName: string | null;
-    /**
-     * An array of names for input variable columns. Can be null.
-     */
-    inputVariableNames?: string[] | null;
-    /**
-     * The name of the column that stores latency data. Can be null.
-     */
-    latencyColumnName: string | null;
-    /**
-     * The name of the column that stores the number of tokens. Can be null.
-     */
-    numOfTokenColumnName: string | null;
-    /**
-     * The name of the column that stores output data. Can be null.
-     */
-    outputColumnName: string | null;
-    /**
-     * The full prompt history for the chat completion.
-     */
-    prompt?: ChatCompletionMessageParam[];
-    /**
-     * The name of the column that stores timestamp data. Can be null.
-     */
-    timestampColumnName: string | null;
-}
-type OpenlayerClientConstructorProps = {
-    openlayerApiKey?: string | undefined;
-    openlayerServerUrl?: string | undefined;
-};
-type OpenAIMonitorConstructorProps = OpenlayerClientConstructorProps & {
-    openAiApiKey: string;
-    openlayerInferencePipelineId?: string;
-    openlayerInferencePipelineName?: string;
-    openlayerProjectName?: string;
-};
-type OpenlayerInferencePipeline = {
-    dataVolumeGraphs?: OpenlayerSampleVolumeGraph;
-    dateCreated: string;
-    dateLastEvaluated?: string;
-    dateLastSampleReceived?: string;
-    dateOfNextEvaluation?: string;
-    dateUpdated: string;
-    description?: string;
-    failingGoalCount: number;
-    id: string;
-    name: string;
-    passingGoalCount: number;
-    projectId: string;
-    status: OpenlayerInferencePipelineStatus;
-    statusMessage?: string;
-    totalGoalCount: number;
-};
-type OpenlayerInferencePipelineStatus = 'completed' | 'failed' | 'paused' | 'queued' | 'running' | 'unknown';
-type OpenlayerProject = {
-    dateCreated: string;
-    dateUpdated: string;
-    description?: string;
-    developmentGoalCount: number;
-    goalCount: number;
-    id: string;
-    inferencePipelineCount: number;
-    memberIds: string[];
-    monitoringGoalCount: number;
-    name: string;
-    sample?: boolean;
-    slackChannelId?: string;
-    slackChannelName?: string;
-    slackChannelNotificationsEnabled: boolean;
-    taskType: OpenlayerTaskType;
-    unreadNotificationCount: number;
-    versionCount: number;
-};
-type OpenlayerSampleVolumeGraphBucket = {
-    title: string;
-    xAxis: {
-        data: string[];
-        title: string;
-    };
-    yAxis: {
-        data: number[];
-        title: string;
-    };
-};
-type OpenlayerSampleVolumeGraph = {
-    daily: OpenlayerSampleVolumeGraphBucket;
-    hourly: OpenlayerSampleVolumeGraphBucket;
-    monthly: OpenlayerSampleVolumeGraphBucket;
-    weekly: OpenlayerSampleVolumeGraphBucket;
-};
-type OpenlayerTaskType = 'llm-base' | 'tabular-classification' | 'tabular-regression' | 'text-classification';
-export declare class OpenlayerClient {
-    private openlayerApiKey?;
-    defaultConfig: StreamingDataConfig;
-    private openlayerServerUrl;
-    private version;
-    /**
-     * Constructs an OpenlayerClient instance.
-     * @param {OpenlayerClientConstructorProps} props - The config for the Openlayer client. The API key is required.
-     */
-    constructor({ openlayerApiKey, openlayerServerUrl, }: OpenlayerClientConstructorProps);
-    private resolvedQuery;
-    /**
-     * Creates a new inference pipeline in Openlayer or loads an existing one.
-     * @param {string} projectId - The ID of the project containing the inference pipeline.
-     * @param {string} [name='production'] - The name of the inference pipeline, defaults to 'production'.
-     * @returns {Promise<OpenlayerInferencePipeline>} A promise that resolves to an OpenlayerInferencePipeline object.
-     * @throws {Error} Throws an error if the inference pipeline cannot be created or found.
-     */
-    createInferencePipeline: (projectId: string, name?: string) => Promise<OpenlayerInferencePipeline>;
-    /**
-     * Creates a new project in Openlayer or loads an existing one.
-     * @param {string} name - The name of the project.
-     * @param {OpenlayerTaskType} taskType - The type of task associated with the project.
-     * @param {string} [description] - Optional description of the project.
-     * @returns {Promise<OpenlayerProject>} A promise that resolves to an OpenlayerProject object.
-     * @throws {Error} Throws an error if the project cannot be created or found.
-     */
-    createProject: (name: string, taskType: OpenlayerTaskType, description?: string) => Promise<OpenlayerProject>;
-    /**
-     * Loads an existing inference pipeline from Openlayer based on its name and project ID.
-     * @param {string} projectId - The ID of the project containing the inference pipeline.
-     * @param {string} [name='production'] - The name of the inference pipeline, defaults to 'production'.
-     * @returns {Promise<OpenlayerInferencePipeline>} A promise that resolves to an OpenlayerInferencePipeline object.
-     * @throws {Error} Throws an error if the inference pipeline is not found.
-     */
-    loadInferencePipeline: (projectId: string, name?: string) => Promise<OpenlayerInferencePipeline>;
-    /**
-     * Loads an existing project from Openlayer based on its name.
-     * @param {string} name - The name of the project.
-     * @returns {Promise<OpenlayerProject>} A promise that resolves to an OpenlayerProject object.
-     * @throws {Error} Throws an error if the project is not found.
-     */
-    loadProject: (name: string) => Promise<OpenlayerProject>;
-    /**
-     * Streams data to the Openlayer inference pipeline.
-     * @param {StreamingData} data - The chat completion data to be streamed.
-     * @param {string} inferencePipelineId - The ID of the Openlayer inference pipeline to which data is streamed.
-     * @returns {Promise<void>} A promise that resolves when the data has been successfully streamed.
-     */
-    streamData: (data: StreamingData, config: StreamingDataConfig, inferencePipelineId: string) => Promise<void>;
-}
-export declare class OpenAIMonitor {
-    private openlayerClient;
-    private openAIClient;
-    private openlayerProjectName?;
-    private openlayerInferencePipelineId?;
-    private openlayerInferencePipelineName;
-    /**
-     * Constructs an OpenAIMonitor instance.
-     * @param {OpenAIMonitorConstructorProps} props - The configuration properties for the OpenAI and Openlayer clients.
-     */
-    constructor({ openAiApiKey, openlayerApiKey, openlayerProjectName, openlayerInferencePipelineId, openlayerInferencePipelineName, openlayerServerUrl, }: OpenAIMonitorConstructorProps);
-    private cost;
-    private chatCompletionPrompt;
-    private threadPrompt;
-    private inputVariables;
-    /**
-     * Creates a chat completion using the OpenAI client and streams the result to Openlayer.
-     * @param {ChatCompletionCreateParams} body - The parameters for creating a chat completion.
-     * @param {RequestOptions} [options] - Optional request options.
-     * @param {StreamingData} [additionalLogs] - Optional metadata logs to include with the request sent to Openlayer.
-     * @returns {Promise<ChatCompletion | Stream<ChatCompletionChunk>>} Promise of a ChatCompletion or a Stream
-     * @throws {Error} Throws errors from the OpenAI client.
-     */
-    createChatCompletion: (body: ChatCompletionCreateParams, options?: RequestOptions, additionalLogs?: StreamingData) => Promise<ChatCompletion | Stream<ChatCompletionChunk>>;
-    /**
-     * Creates a completion using the OpenAI client and streams the result to Openlayer.
-     * @param {CompletionCreateParams} body - The parameters for creating a completion.
-     * @param {RequestOptions} [options] - Optional request options.
-     * @param {StreamingData} [additionalLogs] - Optional metadata logs to include with the request sent to Openlayer.
-     * @returns {Promise<Completion | Stream<Completion>>} Promise that resolves to a Completion or a Stream.
-     * @throws {Error} Throws errors from the OpenAI client.
-     */
-    createCompletion: (body: CompletionCreateParams, options?: RequestOptions, additionalLogs?: StreamingData) => Promise<Completion | Stream<Completion>>;
-    /**
-     * Monitor a run from an OpenAI assistant.
-     * Once the run is completed, the thread data is published to Openlayer,
-     * along with the latency, cost, and number of tokens used.
-     * @param {Run} run - The run created by the OpenAI assistant.
-     * @param {StreamingData} [additionalLogs] - Optional metadata logs to include with the request sent to Openlayer.
-     * @returns {Promise<void>} A promise that resolves when the run data has been successfully published to Openlayer.
-     */
-    monitorThreadRun(run: Run, additionalLogs?: StreamingData): Promise<void>;
-    /**
-     * Starts monitoring for the OpenAI Monitor instance. If monitoring is already active, a warning is logged.
-     */
-    initialize(): Promise<void>;
-}
-export {};
-//# sourceMappingURL=index.d.ts.map

package/lib/core/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/core/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EACL,cAAc,EACd,mBAAmB,EACnB,0BAA0B,EAC1B,0BAA0B,EAC1B,UAAU,EACV,sBAAsB,EACvB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,GAAG,EAAE,MAAM,yCAAyC,CAAC;AAE9D,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAgD1C;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,CAAC,UAAU,EAAE,MAAM,GAAG,GAAG,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,UAAU,mBAAmB;IAC3B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,qBAAqB,EAAE,MAAM,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAErC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAC,EAAE,0BAA0B,EAAE,CAAC;IAEtC;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;CACpC;AAED,KAAK,+BAA+B,GAAG;IACrC,eAAe,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,KAAK,6BAA6B,GAAG,+BAA+B,GAAG;IACrE,YAAY,EAAE,MAAM,CAAC;IACrB,4BAA4B,CAAC,EAAE,MAAM,CAAC;IACtC,8BAA8B,CAAC,EAAE,MAAM,CAAC;IACxC,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,gBAAgB,CAAC,EAAE,0BAA0B,CAAC;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gBAAgB,EAAE,MAAM,CAAC;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,gCAAgC,CAAC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,KAAK,gCAAgC,GACjC,WAAW,GACX,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,CAAC;AAEd,KAAK,gBAAgB,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,sBAAsB,EAAE,MAAM,CAAC;IAC/B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gCAAgC,EAAE,OAAO,CAAC;IAC1C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,gCAAgC,GAAG;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF,KAAK,0BAA0B,GAAG;IAChC,KAAK,EAAE,gCAAgC,CAAC;IACxC,MAAM,EAAE,gCAAgC,CAAC;IACzC,OAAO,EAAE,gCAAgC,CAAC;IAC1C,MAAM,EAAE,gCAAgC,CAAC;CAC1C,CAAC;AAEF,KAAK,iBAAiB,GAClB,UAAU,GACV,wBAAwB,GACxB,oBAAoB,GACpB,qBAAqB,CAAC;AAkF1B,qBAAa,eAAe;IAC1B,OAAO,CAAC,eAAe,CAAC,CAAqB;IAEtC,aAAa,EAAE,mBAAmB,CAQvC;IAEF,OAAO,CAAC,kBAAkB,CAA0C;IAEpE,OAAO,CAAC,OAAO,CAAc;IAE7B;;;OAGG;gBACS,EACV,eAAe,EACf,kBAAkB,GACnB,EAAE,+BAA+B;IAYlC,OAAO,CAAC,aAAa,CACoC;IAEzD;;;;;;OAMG;IACI,uBAAuB,cACjB,MAAM,SACX,MAAM,KACX,QAAQ,0BAA0B,CAAC,CAmCpC;IAEF;;;;;;;OAOG;IACI,aAAa,SACZ,MAAM,YACF,iBAAiB,gBACb,MAAM,KACnB,QAAQ,gBAAgB,CAAC,CAyC1B;IAEF;;;;;;OAMG;IACI,qBAAqB,cACf,MAAM,SACX,MAAM,KACX,QAAQ,0BAA0B,CAAC,CAqCpC;IAEF;;;;;OAKG;IACI,WAAW,SAAgB,MAAM,KAAG,QAAQ,gBAAgB,CAAC,CAuClE;IAEF;;;;;OAKG;IACI,UAAU,SACT,aAAa,UACX,mBAAmB,uBACN,MAAM,KAC1B,QAAQ,IAAI,CAAC,CAqCd;CACH;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,eAAe,CAAkB;IAEzC,OAAO,CAAC,YAAY,CAAS;IAE7B,OAAO,CAAC,oBAAoB,CAAC,CAAqB;IAElD,OAAO,CAAC,4BAA4B,CAAC,CAAqB;IAE1D,OAAO,CAAC,8BAA8B,CAAwB;IAE9D;;;OAGG;gBACS,EACV,YAAY,EACZ,eAAe,EACf,oBAAoB,EACpB,4BAA4B,EAC5B,8BAA8B,EAC9B,kBAAkB,GACnB,EAAE,6BAA6B;IAmBhC,OAAO,CAAC,IAAI,CAaV;IAEF,OAAO,CAAC,oBAAoB,CASxB;IAEJ,OAAO,CAAC,YAAY,CAyBlB;IAEF,OAAO,CAAC,cAAc,CAkBpB;IAEF;;;;;;;OAOG;IACI,oBAAoB,SACnB,0BAA0B,YACtB,cAAc,mBACP,aAAa,KAC7B,QAAQ,cAAc,GAAG,OAAO,mBAAmB,CAAC,CAAC,CA+FtD;IAEF;;;;;;;OAOG;IACI,gBAAgB,SACf,sBAAsB,YAClB,cAAc,mBACP,aAAa,KAC7B,QAAQ,UAAU,GAAG,OAAO,UAAU,CAAC,CAAC,CAkGzC;IAEF;;;;;;;OAOG;IACU,gBAAgB,CAAC,GAAG,EAAE,GAAG,EAAE,cAAc,CAAC,EAAE,aAAa;IAoFtE;;OAEG;IACU,UAAU;CA0CxB"}