opik 0.0.1 → 0.0.2

package/src/opik/rest_api/api/resources/experiments/client/index.ts

@@ -1 +0,0 @@
-export * from "./requests";

package/src/opik/rest_api/api/resources/experiments/client/requests/ExperimentItemStreamRequest.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export interface ExperimentItemStreamRequest {
-    experimentName: string;
-    limit?: number;
-    lastRetrievedId?: string;
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/ExperimentItemsBatch.ts

@@ -1,19 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../../../../index";
-
-/**
- * @example
- *     {
- *         experimentItems: [{
- *                 experimentId: "experiment_id",
- *                 datasetItemId: "dataset_item_id",
- *                 traceId: "trace_id"
- *             }]
- *     }
- */
-export interface ExperimentItemsBatch {
-    experimentItems: OpikApi.ExperimentItem[];
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/ExperimentItemsDelete.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {
- *         ids: ["ids"]
- *     }
- */
-export interface ExperimentItemsDelete {
-    ids: string[];
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/ExperimentWrite.ts

@@ -1,19 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../../../../index";
-
-/**
- * @example
- *     {
- *         datasetName: "dataset_name"
- *     }
- */
-export interface ExperimentWrite {
-    id?: string;
-    datasetName: string;
-    name?: string;
-    metadata?: OpikApi.JsonNodeWrite;
-    promptVersion?: OpikApi.PromptVersionLinkWrite;
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/ExperimentsDelete.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {
- *         ids: ["ids"]
- *     }
- */
-export interface ExperimentsDelete {
-    ids: string[];
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/FindExperimentsRequest.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {}
- */
-export interface FindExperimentsRequest {
-    page?: number;
-    size?: number;
-    datasetId?: string;
-    name?: string;
-    datasetDeleted?: boolean;
-    promptId?: string;
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/FindFeedbackScoreNamesRequest.ts

@@ -1,11 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {}
- */
-export interface FindFeedbackScoreNamesRequest {
-    experimentIds?: string;
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/IdentifierPublic.ts

@@ -1,13 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {
- *         name: "name"
- *     }
- */
-export interface IdentifierPublic {
-    name: string;
-}

package/src/opik/rest_api/api/resources/experiments/client/requests/index.ts

@@ -1,8 +0,0 @@
-export { type FindExperimentsRequest } from "./FindExperimentsRequest";
-export { type ExperimentWrite } from "./ExperimentWrite";
-export { type ExperimentItemsBatch } from "./ExperimentItemsBatch";
-export { type ExperimentItemsDelete } from "./ExperimentItemsDelete";
-export { type ExperimentsDelete } from "./ExperimentsDelete";
-export { type FindFeedbackScoreNamesRequest } from "./FindFeedbackScoreNamesRequest";
-export { type IdentifierPublic } from "./IdentifierPublic";
-export { type ExperimentItemStreamRequest } from "./ExperimentItemStreamRequest";

package/src/opik/rest_api/api/resources/experiments/index.ts

@@ -1 +0,0 @@
-export * from "./client";

package/src/opik/rest_api/api/resources/feedbackDefinitions/client/Client.ts

@@ -1,515 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as OpikApi from "../../../index";
-import urlJoin from "url-join";
-import * as serializers from "../../../../serialization/index";
-import * as errors from "../../../../errors/index";
-
-export declare namespace FeedbackDefinitions {
-    interface Options {
-        environment?: core.Supplier<environments.OpikApiEnvironment | string>;
-        /** Override the Authorization header */
-        apiKey?: core.Supplier<string | undefined>;
-        /** Override the Comet-Workspace header */
-        workspaceName?: core.Supplier<string | undefined>;
-    }
-
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** 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>;
-    }
-}
-
-/**
- * Feedback definitions related resources
- */
-export class FeedbackDefinitions {
-    constructor(protected readonly _options: FeedbackDefinitions.Options = {}) {}
-
-    /**
-     * Find Feedback definitions
-     *
-     * @param {OpikApi.FindFeedbackDefinitionsRequest} request
-     * @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.feedbackDefinitions.findFeedbackDefinitions()
-     */
-    public findFeedbackDefinitions(
-        request: OpikApi.FindFeedbackDefinitionsRequest = {},
-        requestOptions?: FeedbackDefinitions.RequestOptions
-    ): core.APIPromise<OpikApi.FeedbackDefinitionPagePublic> {
-        return core.APIPromise.from(
-            (async () => {
-                const { page, size, name, type: type_ } = request;
-                const _queryParams: Record<string, string | string[] | object | object[]> = {};
-                if (page != null) {
-                    _queryParams["page"] = page.toString();
-                }
-                if (size != null) {
-                    _queryParams["size"] = size.toString();
-                }
-                if (name != null) {
-                    _queryParams["name"] = name;
-                }
-                if (type_ != null) {
-                    _queryParams["type"] = type_;
-                }
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        "v1/private/feedback-definitions"
-                    ),
-                    method: "GET",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    queryParameters: _queryParams,
-                    requestType: "json",
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: serializers.FeedbackDefinitionPagePublic.parseOrThrow(_response.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }),
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling GET /v1/private/feedback-definitions."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    /**
-     * Get feedback definition
-     *
-     * @param {OpikApi.FeedbackCreate} request
-     * @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.feedbackDefinitions.createFeedbackDefinition({
-     *         type: "categorical"
-     *     })
-     */
-    public createFeedbackDefinition(
-        request: OpikApi.FeedbackCreate,
-        requestOptions?: FeedbackDefinitions.RequestOptions
-    ): core.APIPromise<void> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        "v1/private/feedback-definitions"
-                    ),
-                    method: "POST",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    body: serializers.FeedbackCreate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: undefined,
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling POST /v1/private/feedback-definitions."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    /**
-     * Get feedback definition by id
-     *
-     * @param {string} id
-     * @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.feedbackDefinitions.getFeedbackDefinitionById("id")
-     */
-    public getFeedbackDefinitionById(
-        id: string,
-        requestOptions?: FeedbackDefinitions.RequestOptions
-    ): core.APIPromise<OpikApi.FeedbackPublic> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        `v1/private/feedback-definitions/${encodeURIComponent(id)}`
-                    ),
-                    method: "GET",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: serializers.FeedbackPublic.parseOrThrow(_response.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }),
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling GET /v1/private/feedback-definitions/{id}."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    /**
-     * Update feedback definition by id
-     *
-     * @param {string} id
-     * @param {OpikApi.FeedbackUpdate} request
-     * @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.feedbackDefinitions.updateFeedbackDefinition("id", {
-     *         type: "categorical"
-     *     })
-     */
-    public updateFeedbackDefinition(
-        id: string,
-        request: OpikApi.FeedbackUpdate,
-        requestOptions?: FeedbackDefinitions.RequestOptions
-    ): core.APIPromise<void> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        `v1/private/feedback-definitions/${encodeURIComponent(id)}`
-                    ),
-                    method: "PUT",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    body: serializers.FeedbackUpdate.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: undefined,
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling PUT /v1/private/feedback-definitions/{id}."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    /**
-     * Delete feedback definition by id
-     *
-     * @param {string} id
-     * @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.feedbackDefinitions.deleteFeedbackDefinitionById("id")
-     */
-    public deleteFeedbackDefinitionById(
-        id: string,
-        requestOptions?: FeedbackDefinitions.RequestOptions
-    ): core.APIPromise<void> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        `v1/private/feedback-definitions/${encodeURIComponent(id)}`
-                    ),
-                    method: "DELETE",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: undefined,
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling DELETE /v1/private/feedback-definitions/{id}."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    /**
-     * Delete feedback definitions batch
-     *
-     * @param {OpikApi.BatchDelete} request
-     * @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.feedbackDefinitions.deleteFeedbackDefinitionsBatch({
-     *         ids: ["ids"]
-     *     })
-     */
-    public deleteFeedbackDefinitionsBatch(
-        request: OpikApi.BatchDelete,
-        requestOptions?: FeedbackDefinitions.RequestOptions
-    ): core.APIPromise<void> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        "v1/private/feedback-definitions/delete"
-                    ),
-                    method: "POST",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    body: serializers.BatchDelete.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: undefined,
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling POST /v1/private/feedback-definitions/delete."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    protected async _getCustomAuthorizationHeaders() {
-        const apiKeyValue = await core.Supplier.get(this._options.apiKey);
-        return { Authorization: apiKeyValue };
-    }
-}

package/src/opik/rest_api/api/resources/feedbackDefinitions/client/index.ts

@@ -1 +0,0 @@
-export * from "./requests";

package/src/opik/rest_api/api/resources/feedbackDefinitions/client/requests/FindFeedbackDefinitionsRequest.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../../../../index";
-
-/**
- * @example
- *     {}
- */
-export interface FindFeedbackDefinitionsRequest {
-    page?: number;
-    size?: number;
-    name?: string;
-    type?: OpikApi.FindFeedbackDefinitionsRequestType;
-}

package/src/opik/rest_api/api/resources/feedbackDefinitions/client/requests/index.ts

@@ -1 +0,0 @@
-export { type FindFeedbackDefinitionsRequest } from "./FindFeedbackDefinitionsRequest";