scorecard-ai 0.2.0 → 0.3.0

package/dist/api/resources/prompt/client/Client.d.ts

@@ -0,0 +1,151 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Scorecard from "../../../index";
+export declare namespace Prompt {
+    interface Options {
+        environment?: core.Supplier<environments.ScorecardEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class Prompt {
+    protected readonly _options: Prompt.Options;
+    constructor(_options: Prompt.Options);
+    /**
+     * Create a new prompt
+     *
+     * @param {Scorecard.PromptCreateParams} request
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.prompt.create({
+     *         promptTemplate: "You are a virtual assistant",
+     *         name: "Prompt Name",
+     *         description: "Description of the prompt",
+     *         modelParams: {
+     *             "param1": "value1",
+     *             "param2": 0.1,
+     *             "param3": 100,
+     *             "param4": true
+     *         }
+     *     })
+     *
+     * @example
+     *     await scorecard.prompt.create({
+     *         promptTemplate: "You are a virtual assistant",
+     *         parentId: "7ac3cbd5-3b99-4e72-97f3-9cd2e749cace",
+     *         description: "Description of the prompt",
+     *         modelParams: {
+     *             "param1": "value1",
+     *             "param2": 0.1,
+     *             "param3": 100,
+     *             "param4": true
+     *         },
+     *         isProd: true
+     *     })
+     */
+    create(request: Scorecard.PromptCreateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * Retrieve active root prompts for the org
+     *
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     *
+     * @example
+     *     await scorecard.prompt.getRoots()
+     */
+    getRoots(requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt[]>;
+    /**
+     * Retrieve prod prompts for the org
+     *
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     *
+     * @example
+     *     await scorecard.prompt.getProds()
+     */
+    getProds(requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt[]>;
+    /**
+     * Retrieve a prompt by id
+     *
+     * @param {string} id - The id of the prompt to get.
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.prompt.get("id")
+     */
+    get(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * Update a prompt
+     *
+     * @param {string} id - The id of the prompt to update.
+     * @param {Scorecard.PromptUpdateParams} request
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.prompt.update("id", {
+     *         isArchived: true
+     *     })
+     */
+    update(id: string, request?: Scorecard.PromptUpdateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * Retrieve a prod prompt by name
+     *
+     * @param {string} name - Name of the prompt.
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.prompt.getByName("name")
+     */
+    getByName(name: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * Retrieve all nodes within the same graph as the prompt, sorted by created_at desc
+     *
+     * @param {string} id - The id of the prompt.
+     * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Scorecard.UnauthorizedError}
+     * @throws {@link Scorecard.ForbiddenError}
+     * @throws {@link Scorecard.NotFoundError}
+     * @throws {@link Scorecard.UnprocessableEntityError}
+     *
+     * @example
+     *     await scorecard.prompt.getGraph("id")
+     */
+    getGraph(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt[]>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-Key": string;
+    }>;
+}