opik 2.0.68 → 2.0.69

package/dist/index.d.cts

@@ -371,6 +371,80 @@ interface GetLatestBlueprintRequest {
     maskId?: string;
 }
 
+/**
+ * @example
+ *     {
+ *         projectId: "project_id",
+ *         status: "open"
+ *     }
+ */
+interface AgentInsightsIssueUpdate {
+    projectId: string;
+    status: AgentInsightsIssueUpdateStatus;
+}
+
+/**
+ * @example
+ *     {
+ *         projectId: "project_id",
+ *         reportDay: "2023-01-15",
+ *         issues: [{
+ *                 name: "name",
+ *                 count: 1000000,
+ *                 totalCount: 1000000,
+ *                 usersImpacted: 1000000,
+ *                 totalUsers: 1000000
+ *             }]
+ *     }
+ */
+interface AgentInsightsReport {
+    projectId: string;
+    reportDay: string;
+    issues: ReportedIssue[];
+}
+
+/**
+ * @example
+ *     {
+ *         projectId: "project_id"
+ *     }
+ */
+interface FindAgentInsightsIssuesRequest {
+    projectId: string;
+    fromDate?: string;
+    toDate?: string;
+    status?: FindAgentInsightsIssuesRequestStatus;
+    sorting?: string;
+    page?: number;
+    size?: number;
+}
+
+/**
+ * @example
+ *     {
+ *         projectId: "project_id"
+ *     }
+ */
+interface GetAgentInsightsIssueByIdRequest {
+    projectId: string;
+    fromDate?: string;
+    toDate?: string;
+}
+
+declare const AgentInsightsIssueUpdateStatus: {
+    readonly Open: "open";
+    readonly Resolved: "resolved";
+    readonly Closed: "closed";
+};
+type AgentInsightsIssueUpdateStatus = (typeof AgentInsightsIssueUpdateStatus)[keyof typeof AgentInsightsIssueUpdateStatus];
+
+declare const FindAgentInsightsIssuesRequestStatus: {
+    readonly Open: "open";
+    readonly Resolved: "resolved";
+    readonly Closed: "closed";
+};
+type FindAgentInsightsIssuesRequestStatus = (typeof FindAgentInsightsIssuesRequestStatus)[keyof typeof FindAgentInsightsIssuesRequestStatus];
+
 /**
  * @example
  *     {
@@ -2854,6 +2928,17 @@ declare const SpanSearchStreamRequestPublicType: {
 };
 type SpanSearchStreamRequestPublicType = (typeof SpanSearchStreamRequestPublicType)[keyof typeof SpanSearchStreamRequestPublicType];
 
+/**
+ * @example
+ *     {
+ *         query: "query"
+ *     }
+ */
+interface AnalyticsQueryRequest {
+    /** Read-only ClickHouse SQL. Must return exactly one column named `result` produced via toJSONString(...) */
+    query: string;
+}
+
 /**
  * @example
  *     {
@@ -3374,6 +3459,83 @@ declare const AgentConfigValueWriteType: {
 };
 type AgentConfigValueWriteType = (typeof AgentConfigValueWriteType)[keyof typeof AgentConfigValueWriteType];
 
+interface AgentInsightsIssue {
+    id?: string;
+    name?: string;
+    description?: string;
+    cause?: string;
+    suggestedFix?: string;
+    status?: AgentInsightsIssueStatus;
+    tracesQuery?: string;
+    /** SUM(count) over the requested window */
+    totalOccurrences?: number;
+    /** SUM(total_count) over the requested window */
+    total?: number;
+    /** SUM(users_impacted) over the requested window */
+    usersImpacted?: number;
+    /** SUM(total_users) over the requested window */
+    totalUsers?: number;
+    /** MIN(report_day) in the requested window */
+    firstSeen?: string;
+    /** MAX(report_day) in the requested window */
+    lastSeen?: string;
+    /** COUNT(DISTINCT report_day) in the requested window */
+    daysReported?: number;
+    createdBy?: string;
+    createdAt?: Date;
+    lastUpdatedBy?: string;
+    lastUpdatedAt?: Date;
+}
+
+/**
+ * Per-day breakdown within the requested window, ordered by report_day ascending
+ */
+interface AgentInsightsIssueDetail {
+    reportDay?: string;
+    count?: number;
+    totalCount?: number;
+    usersImpacted?: number;
+    totalUsers?: number;
+    metadata?: JsonNode;
+}
+
+interface AgentInsightsIssuePage {
+    page?: number;
+    size?: number;
+    total?: number;
+    content?: AgentInsightsIssue[];
+}
+
+declare const AgentInsightsIssueStatus: {
+    readonly Open: "open";
+    readonly Resolved: "resolved";
+    readonly Closed: "closed";
+};
+type AgentInsightsIssueStatus = (typeof AgentInsightsIssueStatus)[keyof typeof AgentInsightsIssueStatus];
+
+interface AgentInsightsIssueWithDetails {
+    id?: string;
+    name?: string;
+    description?: string;
+    cause?: string;
+    suggestedFix?: string;
+    status?: AgentInsightsIssueWithDetailsStatus;
+    tracesQuery?: string;
+    createdBy?: string;
+    createdAt?: Date;
+    lastUpdatedBy?: string;
+    lastUpdatedAt?: Date;
+    /** Per-day breakdown within the requested window, ordered by report_day ascending */
+    details?: AgentInsightsIssueDetail[];
+}
+
+declare const AgentInsightsIssueWithDetailsStatus: {
+    readonly Open: "open";
+    readonly Resolved: "resolved";
+    readonly Closed: "closed";
+};
+type AgentInsightsIssueWithDetailsStatus = (typeof AgentInsightsIssueWithDetailsStatus)[keyof typeof AgentInsightsIssueWithDetailsStatus];
+
 interface AggregationData {
     experimentCount?: number;
     traceCount?: number;
@@ -3519,6 +3681,10 @@ declare const AlertWriteAlertType: {
 };
 type AlertWriteAlertType = (typeof AlertWriteAlertType)[keyof typeof AlertWriteAlertType];
 
+interface AnalyticsQueryResponse {
+    results?: JsonNode[];
+}
+
 interface AnnotationQueueItemIds {
     ids: string[];
 }
@@ -6569,6 +6735,20 @@ interface RecentActivityPagePublic {
     content?: RecentActivityItemPublic[];
 }
 
+interface ReportedIssue {
+    id?: string;
+    name: string;
+    description?: string;
+    cause?: string;
+    suggestedFix?: string;
+    tracesQuery?: string;
+    count: number;
+    totalCount: number;
+    usersImpacted: number;
+    totalUsers: number;
+    metadata?: JsonNode;
+}
+
 interface ReportPreference {
     projectId?: string;
     enabled?: boolean;
@@ -7690,6 +7870,13 @@ interface UserDefinedMetricPythonCodeWrite {
     arguments: Record<string, string>;
 }
 
+interface ValidatedToken {
+    userName?: string;
+    workspaceId?: string;
+    workspaceName?: string;
+    resource?: string;
+}
+
 interface ValueEntry {
     value?: number;
     reason?: string;
@@ -8164,6 +8351,97 @@ declare class AgentConfigsClient {
     private __removeConfigKeys;
 }
 
+declare namespace AgentInsightsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Agent Insights report results
+ */
+declare class AgentInsightsClient {
+    protected readonly _options: NormalizedClientOptions<AgentInsightsClient.Options>;
+    constructor(options?: AgentInsightsClient.Options);
+    /**
+     * Returns a paginated list of issues that have at least one detail row within the requested time window, with metrics aggregated over the window
+     *
+     * @param {OpikApi.FindAgentInsightsIssuesRequest} request
+     * @param {AgentInsightsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.UnauthorizedError}
+     *
+     * @example
+     *     await client.agentInsights.findAgentInsightsIssues({
+     *         projectId: "project_id"
+     *     })
+     */
+    findAgentInsightsIssues(request: FindAgentInsightsIssuesRequest, requestOptions?: AgentInsightsClient.RequestOptions): HttpResponsePromise<AgentInsightsIssuePage>;
+    private __findAgentInsightsIssues;
+    /**
+     * Upserts the detected issues and their per-day metrics for the given report day in a single transaction. Issue status is never modified by this endpoint.
+     *
+     * @param {OpikApi.AgentInsightsReport} request
+     * @param {AgentInsightsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.UnauthorizedError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.agentInsights.reportAgentInsightsIssues({
+     *         projectId: "project_id",
+     *         reportDay: "2023-01-15",
+     *         issues: [{
+     *                 name: "name",
+     *                 count: 1000000,
+     *                 totalCount: 1000000,
+     *                 usersImpacted: 1000000,
+     *                 totalUsers: 1000000
+     *             }]
+     *     })
+     */
+    reportAgentInsightsIssues(request: AgentInsightsReport, requestOptions?: AgentInsightsClient.RequestOptions): HttpResponsePromise<void>;
+    private __reportAgentInsightsIssues;
+    /**
+     * Returns the issue together with its per-day breakdown within the requested time window
+     *
+     * @param {string} issue_id
+     * @param {OpikApi.GetAgentInsightsIssueByIdRequest} request
+     * @param {AgentInsightsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.UnauthorizedError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.agentInsights.getAgentInsightsIssueById("issue_id", {
+     *         projectId: "project_id"
+     *     })
+     */
+    getAgentInsightsIssueById(issue_id: string, request: GetAgentInsightsIssueByIdRequest, requestOptions?: AgentInsightsClient.RequestOptions): HttpResponsePromise<AgentInsightsIssueWithDetails>;
+    private __getAgentInsightsIssueById;
+    /**
+     * Moves an issue through its lifecycle: open, resolved or closed
+     *
+     * @param {string} issue_id
+     * @param {OpikApi.AgentInsightsIssueUpdate} request
+     * @param {AgentInsightsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.UnauthorizedError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.agentInsights.updateAgentInsightsIssue("issue_id", {
+     *         projectId: "project_id",
+     *         status: "open"
+     *     })
+     */
+    updateAgentInsightsIssue(issue_id: string, request: AgentInsightsIssueUpdate, requestOptions?: AgentInsightsClient.RequestOptions): HttpResponsePromise<void>;
+    private __updateAgentInsightsIssue;
+}
+
 declare namespace AiSpendClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -10356,6 +10634,18 @@ declare class McpOAuthClient {
      */
     token(request?: TokenRequest, requestOptions?: McpOAuthClient.RequestOptions): HttpResponsePromise<TokenResponse>;
     private __token;
+    /**
+     * Introspects a bearer access token and returns the identity it resolves to
+     *
+     * @param {McpOAuthClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.UnauthorizedError}
+     *
+     * @example
+     *     await client.mcpOAuth.validateOAuthToken()
+     */
+    validateOAuthToken(requestOptions?: McpOAuthClient.RequestOptions): HttpResponsePromise<ValidatedToken>;
+    private __validateOAuthToken;
 }
 
 declare namespace OllamaClient {
@@ -12014,6 +12304,37 @@ declare class SpansClient {
     private __updateSpanComment;
 }
 
+declare namespace SystemAnalyticsQueriesClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Internal endpoint to run Agent Insights free-form SQL
+ */
+declare class SystemAnalyticsQueriesClient {
+    protected readonly _options: NormalizedClientOptions<SystemAnalyticsQueriesClient.Options>;
+    constructor(options?: SystemAnalyticsQueriesClient.Options);
+    /**
+     * Runs Ollie-generated read-only SQL bounded to the caller's workspace and the requested project. Returns 501 when the Agent Insights toggle is off.
+     *
+     * @param {string} projectId
+     * @param {OpikApi.AnalyticsQueryRequest} request
+     * @param {SystemAnalyticsQueriesClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.UnprocessableEntityError}
+     * @throws {@link OpikApi.NotImplementedError}
+     *
+     * @example
+     *     await client.systemAnalyticsQueries.executeAnalyticsQuery("projectId", {
+     *         query: "query"
+     *     })
+     */
+    executeAnalyticsQuery(projectId: string, request: AnalyticsQueryRequest, requestOptions?: SystemAnalyticsQueriesClient.RequestOptions): HttpResponsePromise<AnalyticsQueryResponse>;
+    private __executeAnalyticsQuery;
+}
+
 declare namespace SystemUsageClient {
     type Options = BaseClientOptions;
     interface RequestOptions extends BaseRequestOptions {
@@ -12774,8 +13095,10 @@ declare namespace OpikApiClient {
 declare class OpikApiClient {
     protected readonly _options: NormalizedClientOptions<OpikApiClient.Options>;
     protected _mcpOAuth: McpOAuthClient | undefined;
+    protected _systemAnalyticsQueries: SystemAnalyticsQueriesClient | undefined;
     protected _systemUsage: SystemUsageClient | undefined;
     protected _agentConfigs: AgentConfigsClient | undefined;
+    protected _agentInsights: AgentInsightsClient | undefined;
     protected _aiSpend: AiSpendClient | undefined;
     protected _alerts: AlertsClient | undefined;
     protected _annotationQueues: AnnotationQueuesClient | undefined;
@@ -12813,8 +13136,10 @@ declare class OpikApiClient {
     protected _redirect: RedirectClient | undefined;
     constructor(options?: OpikApiClient.Options);
     get mcpOAuth(): McpOAuthClient;
+    get systemAnalyticsQueries(): SystemAnalyticsQueriesClient;
     get systemUsage(): SystemUsageClient;
     get agentConfigs(): AgentConfigsClient;
+    get agentInsights(): AgentInsightsClient;
     get aiSpend(): AiSpendClient;
     get alerts(): AlertsClient;
     get annotationQueues(): AnnotationQueuesClient;