@scenario-labs/sdk 3.2.0 → 3.3.1

package/src/resources/models/prompt-guide.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
+
+export class PromptGuide extends APIResource {
+  /**
+   * Get the prompt guide of the given `modelId`
+   */
+  retrieve(
+    modelID: string,
+    query: PromptGuideRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PromptGuideRetrieveResponse> {
+    return this._client.get(path`/models/${modelID}/prompt-guide`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Update the markdown prompt guide of the given `modelId`
+   */
+  update(
+    modelID: string,
+    params: PromptGuideUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PromptGuideUpdateResponse> {
+    const { projectId, ...body } = params;
+    return this._client.put(path`/models/${modelID}/prompt-guide`, {
+      body,
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
+  }
+}
+
+export interface PromptGuideRetrieveResponse {
+  promptGuide: PromptGuideRetrieveResponse.PromptGuide;
+}
+
+export namespace PromptGuideRetrieveResponse {
+  export interface PromptGuide {
+    /**
+     * The markdown prompt guide used as the system prompt for Prompt Spark.
+     *
+     * Instructions and baked-in examples both live in this single markdown document.
+     * No runtime templating is performed on it.
+     */
+    value: string;
+  }
+}
+
+export interface PromptGuideUpdateResponse {
+  promptGuide: PromptGuideUpdateResponse.PromptGuide;
+}
+
+export namespace PromptGuideUpdateResponse {
+  export interface PromptGuide {
+    /**
+     * The markdown prompt guide used as the system prompt for Prompt Spark.
+     *
+     * Instructions and baked-in examples both live in this single markdown document.
+     * No runtime templating is performed on it.
+     */
+    value: string;
+  }
+}
+
+export interface PromptGuideRetrieveParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export interface PromptGuideUpdateParams {
+  /**
+   * Body param: The markdown prompt guide (ex: `# Instructions\n...`). Set to `null`
+   * to delete the prompt guide.
+   */
+  promptGuide: string;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export declare namespace PromptGuide {
+  export {
+    type PromptGuideRetrieveResponse as PromptGuideRetrieveResponse,
+    type PromptGuideUpdateResponse as PromptGuideUpdateResponse,
+    type PromptGuideRetrieveParams as PromptGuideRetrieveParams,
+    type PromptGuideUpdateParams as PromptGuideUpdateParams,
+  };
+}

package/src/resources/models/scores.ts

@@ -0,0 +1,383 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
+
+export class Scores extends APIResource {
+  /**
+   * Get the prompt scores for the given `modelId`
+   */
+  retrievePrompt(
+    modelID: string,
+    query: ScoreRetrievePromptParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ScoreRetrievePromptResponse> {
+    return this._client.get(path`/models/${modelID}/scores/prompt`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Get the training dataset scores for the given `modelId`
+   */
+  retrieveTrainingDataset(
+    modelID: string,
+    query: ScoreRetrieveTrainingDatasetParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ScoreRetrieveTrainingDatasetResponse> {
+    return this._client.get(path`/models/${modelID}/scores/training-dataset`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
+  }
+}
+
+export interface ScoreRetrievePromptResponse {
+  /**
+   * Different components used to compute the final score
+   */
+  details: ScoreRetrievePromptResponse.Details;
+
+  /**
+   * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+   */
+  modelId: string;
+
+  /**
+   * The prompt's score for the input modelId
+   *
+   * The score is a number between 0 and 1. The higher the score, the better the
+   * prompt is for the model
+   */
+  score: number;
+
+  /**
+   * The status of the prompt's score
+   *
+   * Details if all the necessary data is present to compute the score
+   */
+  status: 'complete' | 'incomplete' | 'unknown';
+
+  /**
+   * Present only if the prompt has one or more syntax errors
+   *
+   * The API checks several syntax errors in the prompt
+   */
+  syntaxError?:
+    | 'Prompt weight should be between 0 and 2'
+    | 'Prompt weight symbol should be - or + with a maximum length of 5. Ex: --, ++, ---, +++++'
+    | "Unsupported prompt syntax: '[to:when], [from::when]'"
+    | "Unsupported prompt syntax: 'word:<weight>' or '(word):<weight>'. Please use 'word<weight>' or '(word)<weight>' instead"
+    | 'Unsupported prompt syntax: --(s|c)ref'
+    | 'Unsupported prompt syntax: <name:weight> or <lora:name:weight>'
+    | 'Unsupported url in prompt';
+}
+
+export namespace ScoreRetrievePromptResponse {
+  /**
+   * Different components used to compute the final score
+   */
+  export interface Details {
+    /**
+     * The Dice-Sørensen similarity between the prompt and each captions from the
+     * model's training images
+     *
+     * The values are between 0 and 1. The higher the value, the more similar the
+     * prompt is to the training images' captions
+     */
+    captionsSimilarity: Details.CaptionsSimilarity;
+
+    /**
+     * The cosine similarity between the prompt and the model's caption embedding
+     *
+     * The value is a number between -1 and 1. The higher the value, the more similar
+     * the prompt is to the model's caption embedding
+     */
+    embeddingSimilarity: number;
+
+    /**
+     * The Dice-Sørensen similarity between the prompt and each prompts from the
+     * model's examples
+     *
+     * The values are between 0 and 1. The higher the value, the more similar the
+     * prompt is to the prompts' examples
+     */
+    promptsSimilarity?: Details.PromptsSimilarity;
+  }
+
+  export namespace Details {
+    /**
+     * The Dice-Sørensen similarity between the prompt and each captions from the
+     * model's training images
+     *
+     * The values are between 0 and 1. The higher the value, the more similar the
+     * prompt is to the training images' captions
+     */
+    export interface CaptionsSimilarity {
+      mean: number;
+
+      median: number;
+
+      min: number;
+    }
+
+    /**
+     * The Dice-Sørensen similarity between the prompt and each prompts from the
+     * model's examples
+     *
+     * The values are between 0 and 1. The higher the value, the more similar the
+     * prompt is to the prompts' examples
+     */
+    export interface PromptsSimilarity {
+      mean: number;
+
+      median: number;
+
+      min: number;
+    }
+  }
+}
+
+export interface ScoreRetrieveTrainingDatasetResponse {
+  /**
+   * Different components used to compute the final score
+   */
+  details: ScoreRetrieveTrainingDatasetResponse.Details;
+
+  /**
+   * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+   */
+  modelId: string;
+
+  /**
+   * The training dataset's score for the input modelId
+   *
+   * The score is a number between 0 and 1. The higher the score, the most chance the
+   * model has to train well
+   */
+  score: number;
+
+  /**
+   * The status of the training dataset's score
+   *
+   * Details if all the necessary data is present to compute the score
+   */
+  status: 'complete' | 'incomplete' | 'unknown';
+
+  /**
+   * Present only if their is a warning between the assets of the couples
+   */
+  assetCouplesWarnings?: Array<ScoreRetrieveTrainingDatasetResponse.AssetCouplesWarning>;
+
+  /**
+   * Present only if the training image assets of the modelId have one or more
+   * warnings
+   */
+  assetsWarnings?: Array<ScoreRetrieveTrainingDatasetResponse.AssetsWarning>;
+}
+
+export namespace ScoreRetrieveTrainingDatasetResponse {
+  /**
+   * Different components used to compute the final score
+   */
+  export interface Details {
+    /**
+     * For each couple of assets in the training dataset, the distance between the
+     * captions
+     */
+    assetCouplesCaptionsDistance: Array<Details.AssetCouplesCaptionsDistance>;
+
+    /**
+     * For each couple of assets in the training dataset, the similarity between the
+     * assets
+     */
+    assetCouplesSimilarity: Array<Details.AssetCouplesSimilarity>;
+
+    /**
+     * For each asset, the similarity with the model's embedding (excluding the current
+     * asset)
+     */
+    assetsEmbeddingSimilarity: Array<Details.AssetsEmbeddingSimilarity>;
+
+    /**
+     * The min, mean, median of the assetsEmbeddingSimilarity
+     */
+    assetsSimilarity: Details.AssetsSimilarity;
+
+    /**
+     * The min, mean, median of the assetCouplesCaptionsDistance
+     */
+    couplesCaptionsDistance: Details.CouplesCaptionsDistance;
+
+    /**
+     * The min, mean, median of the assetCouplesSimilarity
+     */
+    couplesSimilarity: Details.CouplesSimilarity;
+
+    /**
+     * Takes into account all missing data and warnings to compute a metadata score
+     */
+    metadataScore: number;
+  }
+
+  export namespace Details {
+    export interface AssetCouplesCaptionsDistance {
+      /**
+       * The couple of AssetIds (example: ['asset_GTrL3mq4SXWyMxkOHRxlpw',
+       * 'asset_6VrLs8nC1DHWCfKGaVne0gBn'])
+       */
+      couple: Array<string>;
+
+      /**
+       * The Dice-Sørensen distance between the captions of the assetIds of the couple.
+       */
+      distance: number;
+    }
+
+    export interface AssetCouplesSimilarity {
+      /**
+       * The couple of AssetIds (example: ['asset_GTrL3mq4SXWyMxkOHRxlpw',
+       * 'asset_6VrLs8nC1DHWCfKGaVne0gBn'])
+       */
+      couple: Array<string>;
+
+      /**
+       * The cosine similarity between the assetIds of the couple.
+       *
+       * The value is a number between -1 and 1. The higher the value, the more similar
+       * the assets are to each other
+       */
+      similarity: number;
+    }
+
+    export interface AssetsEmbeddingSimilarity {
+      /**
+       * The AssetId associated with their similarity (example:
+       * "asset_GTrL3mq4SXWyMxkOHRxlpw")
+       */
+      assetId: string;
+
+      /**
+       * The cosine similarity between the assetId and the model's embedding minus the
+       * asset's embedding
+       *
+       * The value is a number between -1 and 1. The higher the value, the more similar
+       * the asset is to the model's embedding
+       */
+      similarity: number;
+    }
+
+    /**
+     * The min, mean, median of the assetsEmbeddingSimilarity
+     */
+    export interface AssetsSimilarity {
+      mean: number;
+
+      median: number;
+
+      min: number;
+    }
+
+    /**
+     * The min, mean, median of the assetCouplesCaptionsDistance
+     */
+    export interface CouplesCaptionsDistance {
+      mean: number;
+
+      median: number;
+
+      min: number;
+    }
+
+    /**
+     * The min, mean, median of the assetCouplesSimilarity
+     */
+    export interface CouplesSimilarity {
+      mean: number;
+
+      median: number;
+
+      min: number;
+    }
+  }
+
+  export interface AssetCouplesWarning {
+    /**
+     * The couple of AssetIds (example: ['asset_GTrL3mq4SXWyMxkOHRxlpw',
+     * 'asset_6VrLs8nC1DHWCfKGaVne0gBn'])
+     */
+    couple: Array<string>;
+
+    /**
+     * An indicative message concerning the couple of assets
+     */
+    message: Array<
+      | 'Captions are identical'
+      | 'Captions are too close'
+      | 'Empty caption'
+      | 'Missing caption'
+      | 'Missing metadata'
+      | 'Same asset'
+      | 'Similarity is too high'
+      | 'Similarity with other assets is too low'
+      | 'Width and height must be larger than 1024'
+    >;
+  }
+
+  export interface AssetsWarning {
+    /**
+     * The AssetId which has a warning (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    assetId: string;
+
+    /**
+     * An indicative message concerning the asset
+     */
+    message: Array<
+      | 'Captions are identical'
+      | 'Captions are too close'
+      | 'Empty caption'
+      | 'Missing caption'
+      | 'Missing metadata'
+      | 'Same asset'
+      | 'Similarity is too high'
+      | 'Similarity with other assets is too low'
+      | 'Width and height must be larger than 1024'
+    >;
+  }
+}
+
+export interface ScoreRetrievePromptParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * The prompt to score against the model. Required — the call returns 400 without
+   * it.
+   */
+  prompt?: string;
+}
+
+export interface ScoreRetrieveTrainingDatasetParams {
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export declare namespace Scores {
+  export {
+    type ScoreRetrievePromptResponse as ScoreRetrievePromptResponse,
+    type ScoreRetrieveTrainingDatasetResponse as ScoreRetrieveTrainingDatasetResponse,
+    type ScoreRetrievePromptParams as ScoreRetrievePromptParams,
+    type ScoreRetrieveTrainingDatasetParams as ScoreRetrieveTrainingDatasetParams,
+  };
+}