scorecard-ai 0.5.4 → 0.6.1

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

@@ -11,8 +11,11 @@ export declare namespace Prompt {
         fetcher?: core.FetchFunction;
     }
     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;
     }
 }
@@ -20,11 +23,28 @@ export declare class Prompt {
     protected readonly _options: Prompt.Options;
     constructor(_options: Prompt.Options);
     /**
-     * Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in app).
+     * Retrieve a prompt by name, defaulting to the production prompt, unless a tag to select the prompt by is specified
      *
-     *         A root prompt can be created by providing the `name` param, and it will always be tagged as prod.
+     * @param {Scorecard.PromptGetByNameRequest} 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 client.prompt.getByName({
+     *         name: "name"
+     *     })
+     */
+    getByName(request: Scorecard.PromptGetByNameRequest, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * Two types of prompts can be created - a root prompt or a child prompt (aka Prompt Version in the app).
+     *
+     *         A root prompt can be created by providing the `name` param, and it will always be tagged as production.
      *
-     *         A child prompt can be created by providing the `parent_id` param. Note that the `name` param in this case will be ignored as all descendents from a root prompt would share the root's name. `is_prod` can also be provided to configure whether a child should be tagged as prod.
+     *         A child prompt can be created by providing the `parent_id` param. Note that the `name` param in this case will be ignored as all descendants from a root prompt would share the root's name. `is_prod` can also be provided to configure whether a child should be tagged as production.
      *
      * @param {Scorecard.PromptCreateParams} request
      * @param {Prompt.RequestOptions} requestOptions - Request-specific configuration.
@@ -35,7 +55,7 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.create({
+     *     await client.prompt.create({
      *         promptTemplate: "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
      *         name: "Prompt Name",
      *         description: "Description of the prompt",
@@ -44,11 +64,13 @@ export declare class Prompt {
      *             "param2": 0.1,
      *             "param3": 100,
      *             "param4": true
-     *         }
+     *         },
+     *         tag: "1.0",
+     *         projectId: 1
      *     })
      *
      * @example
-     *     await scorecard.prompt.create({
+     *     await client.prompt.create({
      *         promptTemplate: "<system>\nYou are a helpful assistant. Use the provided context to answer the user's query.\n\nContext: {context}\n</system>\n\n<user>\n{user_query}\n</user>",
      *         parentId: "7ac3cbd5-3b99-4e72-97f3-9cd2e749cace",
      *         description: "Description of the prompt",
@@ -58,10 +80,27 @@ export declare class Prompt {
      *             "param3": 100,
      *             "param4": true
      *         },
-     *         isProd: true
+     *         tag: "v1.1",
+     *         isProd: true,
+     *         projectId: 1
      *     })
      */
     create(request: Scorecard.PromptCreateParams, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
+    /**
+     * List all prompts with cursor-based pagination
+     *
+     * @param {Scorecard.PromptListPromptsRequest} 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 client.prompt.listPrompts()
+     */
+    listPrompts(request?: Scorecard.PromptListPromptsRequest, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.PromptCursorPage>;
     /**
      * Retrieve a prompt by id
      *
@@ -74,7 +113,7 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.get("id")
+     *     await client.prompt.get("id")
      */
     get(id: string, requestOptions?: Prompt.RequestOptions): Promise<Scorecard.Prompt>;
     /**
@@ -89,7 +128,7 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.delete("id")
+     *     await client.prompt.delete("id")
      */
     delete(id: string, requestOptions?: Prompt.RequestOptions): Promise<unknown>;
     /**
@@ -107,26 +146,11 @@ export declare class Prompt {
      * @throws {@link Scorecard.UnprocessableEntityError}
      *
      * @example
-     *     await scorecard.prompt.update("id", {
+     *     await client.prompt.update("id", {
      *         isProd: 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>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-API-Key": string;
     }>;