opik 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -1776,6 +1776,8 @@ interface Span$1 {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScore[];
     totalEstimatedCost?: number;
+    /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
+    duration?: number;
 }
 
 /**
@@ -1899,6 +1901,8 @@ interface SpanPublic {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScorePublic[];
     totalEstimatedCost?: number;
+    /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
+    duration?: number;
 }
 
 /**
@@ -2027,6 +2031,8 @@ interface Trace$1 {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScore[];
     totalEstimatedCost?: number;
+    /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
+    duration?: number;
 }
 
 /**
@@ -2069,6 +2075,8 @@ interface TracePublic {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScorePublic[];
     totalEstimatedCost?: number;
+    /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
+    duration?: number;
 }
 
 /**
@@ -2139,9 +2147,9 @@ declare class APIPromise<T> extends Promise<T> {
 declare namespace SystemUsage {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2151,9 +2159,9 @@ declare namespace SystemUsage {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2202,7 +2210,7 @@ declare class SystemUsage {
      */
     getTracesCountForWorkspaces(requestOptions?: SystemUsage.RequestOptions): APIPromise<TraceCountResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2213,9 +2221,9 @@ declare class SystemUsage {
 declare namespace Check {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2225,9 +2233,9 @@ declare namespace Check {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2255,7 +2263,7 @@ declare class Check {
      */
     access(request: AuthDetailsHolder, requestOptions?: Check.RequestOptions): APIPromise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2266,9 +2274,9 @@ declare class Check {
 declare namespace ChatCompletions {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2278,9 +2286,9 @@ declare namespace ChatCompletions {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2303,7 +2311,7 @@ declare class ChatCompletions {
      */
     createChatCompletions(request?: ChatCompletionRequest, requestOptions?: ChatCompletions.RequestOptions): APIPromise<ChatCompletionResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2314,9 +2322,9 @@ declare class ChatCompletions {
 declare namespace Datasets {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2326,9 +2334,9 @@ declare namespace Datasets {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2507,7 +2515,7 @@ declare class Datasets {
      */
     streamDatasetItems(request: DatasetItemStreamRequest, requestOptions?: Datasets.RequestOptions): APIPromise<stream.Readable>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2518,9 +2526,9 @@ declare class Datasets {
 declare namespace Experiments {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2530,9 +2538,9 @@ declare namespace Experiments {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2659,7 +2667,7 @@ declare class Experiments {
      */
     streamExperimentItems(request: ExperimentItemStreamRequest, requestOptions?: Experiments.RequestOptions): APIPromise<stream.Readable>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2670,9 +2678,9 @@ declare class Experiments {
 declare namespace FeedbackDefinitions {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2682,9 +2690,9 @@ declare namespace FeedbackDefinitions {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2764,7 +2772,7 @@ declare class FeedbackDefinitions {
      */
     deleteFeedbackDefinitionsBatch(request: BatchDelete, requestOptions?: FeedbackDefinitions.RequestOptions): APIPromise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2775,9 +2783,9 @@ declare class FeedbackDefinitions {
 declare namespace LlmProviderKey {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2787,9 +2795,9 @@ declare namespace LlmProviderKey {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2801,6 +2809,18 @@ declare namespace LlmProviderKey {
 declare class LlmProviderKey {
     protected readonly _options: LlmProviderKey.Options;
     constructor(_options?: LlmProviderKey.Options);
+    /**
+     * Delete LLM Provider's ApiKeys batch
+     *
+     * @param {OpikApi.BatchDelete} request
+     * @param {LlmProviderKey.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.llmProviderKey.deleteLlmProviderApiKeysBatch({
+     *         ids: ["ids"]
+     *     })
+     */
+    deleteLlmProviderApiKeysBatch(request: BatchDelete, requestOptions?: LlmProviderKey.RequestOptions): APIPromise<void>;
     /**
      * Find LLM Provider's ApiKeys
      *
@@ -2855,7 +2875,7 @@ declare class LlmProviderKey {
      */
     updateLlmProviderApiKey(id: string, request: ProviderApiKeyUpdate, requestOptions?: LlmProviderKey.RequestOptions): APIPromise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -2866,9 +2886,9 @@ declare class LlmProviderKey {
 declare namespace Projects {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -2878,9 +2898,9 @@ declare namespace Projects {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -2996,7 +3016,7 @@ declare class Projects {
      */
     retrieveProject(request: ProjectRetrievePublic, requestOptions?: Projects.RequestOptions): APIPromise<ProjectPublic>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -3007,9 +3027,9 @@ declare class Projects {
 declare namespace Prompts {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -3019,9 +3039,9 @@ declare namespace Prompts {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -3170,7 +3190,7 @@ declare class Prompts {
      */
     retrievePromptVersion(request: PromptVersionRetrieveDetail, requestOptions?: Prompts.RequestOptions): APIPromise<PromptVersionDetail>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -3181,9 +3201,9 @@ declare class Prompts {
 declare namespace Spans {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -3193,9 +3213,9 @@ declare namespace Spans {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -3354,7 +3374,7 @@ declare class Spans {
      */
     scoreBatchOfSpans(request: FeedbackScoreBatch, requestOptions?: Spans.RequestOptions): APIPromise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -3365,9 +3385,9 @@ declare class Spans {
 declare namespace Traces {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -3377,9 +3397,9 @@ declare namespace Traces {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -3538,7 +3558,7 @@ declare class Traces {
      */
     scoreBatchOfTraces(request: FeedbackScoreBatch, requestOptions?: Traces.RequestOptions): APIPromise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -3549,9 +3569,9 @@ declare class Traces {
 declare namespace OpikApiClient {
     interface Options {
         environment?: Supplier<OpikApiEnvironment | string>;
-        /** Override the authorization header */
-        authorization?: Supplier<string | undefined>;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
         workspaceName?: Supplier<string | undefined>;
     }
     interface RequestOptions {
@@ -3561,9 +3581,9 @@ declare namespace OpikApiClient {
         maxRetries?: number;
         /** A hook to abort the request. */
         abortSignal?: AbortSignal;
-        /** Override the authorization header */
-        authorization?: string | undefined;
-        /** Override the comet-workspace header */
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
         workspaceName?: string | undefined;
         /** Additional headers to include in the request. */
         headers?: Record<string, string>;
@@ -3609,7 +3629,7 @@ declare class OpikApiClient {
     protected _traces: Traces | undefined;
     get traces(): Traces;
     protected _getCustomAuthorizationHeaders(): Promise<{
-        authorization: string | undefined;
+        Authorization: string | undefined;
     }>;
 }
 
@@ -3618,8 +3638,8 @@ interface SavedSpan extends Span$1 {
 }
 declare class Span {
     private data;
-    private apiClient;
-    constructor(data: SavedSpan, apiClient: OpikApiClient);
+    private opik;
+    constructor(data: SavedSpan, opik: OpikClient);
     end: () => Promise<void>;
     update: (updates: Omit<SpanUpdate, "traceId" | "parentSpanId" | "projectId" | "projectName">) => Promise<void>;
 }
@@ -3632,9 +3652,9 @@ interface SpanData extends Omit<Span$1, "startTime" | "traceId"> {
 }
 declare class Trace {
     private data;
-    private apiClient;
+    private opik;
     private spans;
-    constructor(data: SavedTrace, apiClient: OpikApiClient);
+    constructor(data: SavedTrace, opik: OpikClient);
     end: () => Promise<void>;
     span: (spanData: SpanData) => Promise<Span>;
     update: (updates: Omit<TraceUpdate, "projectId" | "projectName">) => Promise<void>;
@@ -3645,8 +3665,10 @@ interface TraceData extends Omit<Trace$1, "startTime"> {
 }
 declare class OpikClient {
     apiClient: OpikApiClient;
-    private config;
+    config: OpikConfig;
+    private existingProjects;
     constructor(explicitConfig?: Partial<OpikConfig>);
+    loadProject: (projectName: string) => Promise<ProjectPublic>;
     trace: (trace: TraceData) => Promise<Trace>;
 }