llama-stack-client 0.4.3 → 0.4.5

package/src/resources/safety.ts

@@ -12,9 +12,7 @@ import * as Shared from './shared';
 
 export class Safety extends APIResource {
   /**
-   * Run shield.
-   *
-   * Run a shield.
+   * Run a safety shield on messages to check for policy violations.
    */
   runShield(body: SafetyRunShieldParams, options?: Core.RequestOptions): Core.APIPromise<RunShieldResponse> {
     return this._client.post('/v1/safety/run-shield', { body, ...options });
@@ -32,6 +30,9 @@ export interface RunShieldResponse {
 }
 
 export interface SafetyRunShieldParams {
+  /**
+   * The messages to run the shield on
+   */
   messages: Array<
     | SafetyRunShieldParams.OpenAIUserMessageParamInput
     | SafetyRunShieldParams.OpenAISystemMessageParam
@@ -40,8 +41,9 @@ export interface SafetyRunShieldParams {
     | SafetyRunShieldParams.OpenAIDeveloperMessageParam
   >;
 
-  params: { [key: string]: unknown };
-
+  /**
+   * The identifier of the shield to run
+   */
   shield_id: string;
 }
 
@@ -50,6 +52,9 @@ export namespace SafetyRunShieldParams {
    * A message from the user in an OpenAI-compatible chat completion request.
    */
   export interface OpenAIUserMessageParamInput {
+    /**
+     * The content of the message, which can include text and other media.
+     */
     content:
       | string
       | Array<
@@ -58,8 +63,14 @@ export namespace SafetyRunShieldParams {
           | OpenAIUserMessageParamInput.OpenAIFile
         >;
 
+    /**
+     * The name of the user message participant.
+     */
     name?: string | null;
 
+    /**
+     * Must be 'user' to identify this as a user message.
+     */
     role?: 'user';
   }
 
@@ -68,8 +79,14 @@ export namespace SafetyRunShieldParams {
      * Text content part for OpenAI-compatible chat completion messages.
      */
     export interface OpenAIChatCompletionContentPartTextParam {
+      /**
+       * The text content of the message.
+       */
       text: string;
 
+      /**
+       * Must be 'text' to identify this as text content.
+       */
       type?: 'text';
     }
 
@@ -78,36 +95,63 @@ export namespace SafetyRunShieldParams {
      */
     export interface OpenAIChatCompletionContentPartImageParam {
       /**
-       * Image URL specification for OpenAI-compatible chat completion messages.
+       * Image URL specification and processing details.
        */
       image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
 
+      /**
+       * Must be 'image_url' to identify this as image content.
+       */
       type?: 'image_url';
     }
 
     export namespace OpenAIChatCompletionContentPartImageParam {
       /**
-       * Image URL specification for OpenAI-compatible chat completion messages.
+       * Image URL specification and processing details.
        */
       export interface ImageURL {
+        /**
+         * URL of the image to include in the message.
+         */
         url: string;
 
-        detail?: string | null;
+        /**
+         * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
+         */
+        detail?: 'low' | 'high' | 'auto' | null;
       }
     }
 
     export interface OpenAIFile {
+      /**
+       * File specification.
+       */
       file: OpenAIFile.File;
 
+      /**
+       * Must be 'file' to identify this as file content.
+       */
       type?: 'file';
     }
 
     export namespace OpenAIFile {
+      /**
+       * File specification.
+       */
       export interface File {
+        /**
+         * Base64-encoded file data.
+         */
         file_data?: string | null;
 
+        /**
+         * ID of an uploaded file.
+         */
         file_id?: string | null;
 
+        /**
+         * Name of the file.
+         */
         filename?: string | null;
       }
     }
@@ -117,10 +161,20 @@ export namespace SafetyRunShieldParams {
    * A system message providing instructions or context to the model.
    */
   export interface OpenAISystemMessageParam {
+    /**
+     * The content of the 'system prompt'. If multiple system messages are provided,
+     * they are concatenated.
+     */
     content: string | Array<OpenAISystemMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
 
+    /**
+     * The name of the system message participant.
+     */
     name?: string | null;
 
+    /**
+     * Must be 'system' to identify this as a system message.
+     */
     role?: 'system';
   }
 
@@ -129,8 +183,14 @@ export namespace SafetyRunShieldParams {
      * Text content part for OpenAI-compatible chat completion messages.
      */
     export interface ListOpenAIChatCompletionContentPartTextParam {
+      /**
+       * The text content of the message.
+       */
       text: string;
 
+      /**
+       * Must be 'text' to identify this as text content.
+       */
       type?: 'text';
     }
   }
@@ -140,15 +200,27 @@ export namespace SafetyRunShieldParams {
    * chat completion request.
    */
   export interface OpenAIAssistantMessageParamInput {
+    /**
+     * The content of the model's response.
+     */
     content?:
       | string
       | Array<OpenAIAssistantMessageParamInput.ListOpenAIChatCompletionContentPartTextParam>
       | null;
 
+    /**
+     * The name of the assistant message participant.
+     */
     name?: string | null;
 
+    /**
+     * Must be 'assistant' to identify this as the model's response.
+     */
     role?: 'assistant';
 
+    /**
+     * List of tool calls. Each tool call is an OpenAIChatCompletionToolCall object.
+     */
     tool_calls?: Array<OpenAIAssistantMessageParamInput.ToolCall> | null;
   }
 
@@ -157,8 +229,14 @@ export namespace SafetyRunShieldParams {
      * Text content part for OpenAI-compatible chat completion messages.
      */
     export interface ListOpenAIChatCompletionContentPartTextParam {
+      /**
+       * The text content of the message.
+       */
       text: string;
 
+      /**
+       * Must be 'text' to identify this as text content.
+       */
       type?: 'text';
     }
 
@@ -166,6 +244,9 @@ export namespace SafetyRunShieldParams {
      * Tool call specification for OpenAI-compatible chat completion responses.
      */
     export interface ToolCall {
+      /**
+       * Unique identifier for the tool call.
+       */
       id?: string | null;
 
       /**
@@ -173,8 +254,14 @@ export namespace SafetyRunShieldParams {
        */
       function?: ToolCall.Function | null;
 
+      /**
+       * Index of the tool call in the list.
+       */
       index?: number | null;
 
+      /**
+       * Must be 'function' to identify this as a function call.
+       */
       type?: 'function';
     }
 
@@ -183,8 +270,14 @@ export namespace SafetyRunShieldParams {
        * Function call details for OpenAI-compatible tool calls.
        */
       export interface Function {
+        /**
+         * Arguments to pass to the function as a JSON string.
+         */
         arguments?: string | null;
 
+        /**
+         * Name of the function to call.
+         */
         name?: string | null;
       }
     }
@@ -195,10 +288,19 @@ export namespace SafetyRunShieldParams {
    * chat completion request.
    */
   export interface OpenAIToolMessageParam {
+    /**
+     * The response content from the tool.
+     */
     content: string | Array<OpenAIToolMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
 
+    /**
+     * Unique identifier for the tool call this response is for.
+     */
     tool_call_id: string;
 
+    /**
+     * Must be 'tool' to identify this as a tool response.
+     */
     role?: 'tool';
   }
 
@@ -207,8 +309,14 @@ export namespace SafetyRunShieldParams {
      * Text content part for OpenAI-compatible chat completion messages.
      */
     export interface ListOpenAIChatCompletionContentPartTextParam {
+      /**
+       * The text content of the message.
+       */
       text: string;
 
+      /**
+       * Must be 'text' to identify this as text content.
+       */
       type?: 'text';
     }
   }
@@ -217,10 +325,19 @@ export namespace SafetyRunShieldParams {
    * A message from the developer in an OpenAI-compatible chat completion request.
    */
   export interface OpenAIDeveloperMessageParam {
+    /**
+     * The content of the developer message.
+     */
     content: string | Array<OpenAIDeveloperMessageParam.ListOpenAIChatCompletionContentPartTextParam>;
 
+    /**
+     * The name of the developer message participant.
+     */
     name?: string | null;
 
+    /**
+     * Must be 'developer' to identify this as a developer message.
+     */
     role?: 'developer';
   }
 
@@ -229,8 +346,14 @@ export namespace SafetyRunShieldParams {
      * Text content part for OpenAI-compatible chat completion messages.
      */
     export interface ListOpenAIChatCompletionContentPartTextParam {
+      /**
+       * The text content of the message.
+       */
       text: string;
 
+      /**
+       * Must be 'text' to identify this as text content.
+       */
       type?: 'text';
     }
   }

package/src/resources/scoring-functions.ts

@@ -54,7 +54,13 @@ export class ScoringFunctions extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of scoring function objects.
+ */
 export interface ListScoringFunctionsResponse {
+  /**
+   * List of scoring function objects.
+   */
   data: ScoringFunctionListResponse;
 }
 
@@ -237,17 +243,27 @@ export namespace ScoringFnParams {
   }
 }
 
+/**
+ * List of scoring function objects.
+ */
 export type ScoringFunctionListResponse = Array<ScoringFn>;
 
 export interface ScoringFunctionRegisterParams {
+  /**
+   * The description of the scoring function.
+   */
   description: string;
 
   return_type: ScoringFunctionRegisterParams.ReturnType;
 
+  /**
+   * The ID of the scoring function to register.
+   */
   scoring_fn_id: string;
 
   /**
-   * Parameters for LLM-as-judge scoring function configuration.
+   * The parameters for the scoring function for benchmark eval, these can be
+   * overridden for app eval.
    */
   params?:
     | ScoringFunctionRegisterParams.LlmAsJudgeScoringFnParams
@@ -255,8 +271,14 @@ export interface ScoringFunctionRegisterParams {
     | ScoringFunctionRegisterParams.BasicScoringFnParams
     | null;
 
+  /**
+   * The ID of the provider to use for the scoring function.
+   */
   provider_id?: string | null;
 
+  /**
+   * The ID of the provider scoring function to use for the scoring function.
+   */
   provider_scoring_fn_id?: string | null;
 }
 

package/src/resources/scoring.ts

@@ -33,6 +33,9 @@ export class Scoring extends APIResource {
  * The response from scoring.
  */
 export interface ScoringScoreResponse {
+  /**
+   * A map of scoring function name to ScoringResult.
+   */
   results: { [key: string]: Shared.ScoringResult };
 }
 
@@ -40,14 +43,26 @@ export interface ScoringScoreResponse {
  * Response from batch scoring operations on datasets.
  */
 export interface ScoringScoreBatchResponse {
+  /**
+   * A map of scoring function name to ScoringResult
+   */
   results: { [key: string]: Shared.ScoringResult };
 
+  /**
+   * (Optional) The identifier of the dataset that was scored
+   */
   dataset_id?: string | null;
 }
 
 export interface ScoringScoreParams {
+  /**
+   * The rows to score.
+   */
   input_rows: Array<{ [key: string]: unknown }>;
 
+  /**
+   * The scoring functions to use for the scoring.
+   */
   scoring_functions: {
     [key: string]:
       | ScoringScoreParams.LlmAsJudgeScoringFnParams
@@ -116,8 +131,14 @@ export namespace ScoringScoreParams {
 }
 
 export interface ScoringScoreBatchParams {
+  /**
+   * The ID of the dataset to score.
+   */
   dataset_id: string;
 
+  /**
+   * The scoring functions to use for the scoring.
+   */
   scoring_functions: {
     [key: string]:
       | ScoringScoreBatchParams.LlmAsJudgeScoringFnParams
@@ -126,6 +147,9 @@ export interface ScoringScoreBatchParams {
       | null;
   };
 
+  /**
+   * Whether to save the results to a dataset.
+   */
   save_results_dataset?: boolean;
 }
 

package/src/resources/shared.ts

@@ -327,28 +327,45 @@ export interface RouteInfo {
  */
 export interface SafetyViolation {
   /**
-   * Severity level of a safety violation.
+   * Severity level of the violation
    */
   violation_level: 'info' | 'warn' | 'error';
 
+  /**
+   * Additional metadata including specific violation codes
+   */
   metadata?: { [key: string]: unknown };
 
+  /**
+   * Message to convey to the user about the violation
+   */
   user_message?: string | null;
 }
 
 /**
- * Sampling parameters.
+ * Sampling parameters for text generation.
  */
 export interface SamplingParams {
+  /**
+   * The maximum number of tokens that can be generated in the completion. The token
+   * count of your prompt plus max_tokens cannot exceed the model's context length.
+   */
   max_tokens?: number | null;
 
+  /**
+   * Number between -2.0 and 2.0. Positive values penalize new tokens based on
+   * whether they appear in the text so far.
+   */
   repetition_penalty?: number | null;
 
+  /**
+   * Up to 4 sequences where the API will stop generating further tokens. The
+   * returned text will not contain the stop sequence.
+   */
   stop?: Array<string> | null;
 
   /**
-   * Greedy sampling strategy that selects the highest probability token at each
-   * step.
+   * The sampling strategy to use.
    */
   strategy?:
     | SamplingParams.GreedySamplingStrategy
@@ -362,6 +379,9 @@ export namespace SamplingParams {
    * step.
    */
   export interface GreedySamplingStrategy {
+    /**
+     * Must be 'greedy' to identify this sampling strategy.
+     */
     type?: 'greedy';
   }
 
@@ -370,10 +390,19 @@ export namespace SamplingParams {
    * with cumulative probability >= p.
    */
   export interface TopPSamplingStrategy {
-    temperature: number | null;
+    /**
+     * Controls randomness in sampling. Higher values increase randomness.
+     */
+    temperature: number;
 
-    top_p?: number | null;
+    /**
+     * Cumulative probability threshold for nucleus sampling.
+     */
+    top_p?: number;
 
+    /**
+     * Must be 'top_p' to identify this sampling strategy.
+     */
     type?: 'top_p';
   }
 
@@ -381,8 +410,14 @@ export namespace SamplingParams {
    * Top-k sampling strategy that restricts sampling to the k most likely tokens.
    */
   export interface TopKSamplingStrategy {
+    /**
+     * Number of top tokens to consider for sampling. Must be at least 1.
+     */
     top_k: number;
 
+    /**
+     * Must be 'top_k' to identify this sampling strategy.
+     */
     type?: 'top_k';
   }
 }
@@ -391,8 +426,14 @@ export namespace SamplingParams {
  * A scoring result for a single row.
  */
 export interface ScoringResult {
+  /**
+   * Map of metric name to aggregated value
+   */
   aggregated_results: { [key: string]: unknown };
 
+  /**
+   * The scoring result for each row. Each row is a map of column name to value.
+   */
   score_rows: Array<{ [key: string]: unknown }>;
 }
 
@@ -401,7 +442,9 @@ export interface ScoringResult {
  */
 export interface SystemMessage {
   /**
-   * A image content item
+   * The content of the 'system prompt'. If multiple system messages are provided,
+   * they are concatenated. The underlying Llama Stack code may also add other system
+   * messages.
    */
   content:
     | string
@@ -409,6 +452,9 @@ export interface SystemMessage {
     | SystemMessage.TextContentItem
     | Array<SystemMessage.ImageContentItemInput | SystemMessage.TextContentItem>;
 
+  /**
+   * Must be 'system' to identify this as a system message.
+   */
   role?: 'system';
 }
 

package/src/resources/shields.ts

@@ -48,7 +48,13 @@ export class Shields extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of all shields.
+ */
 export interface ListShieldsResponse {
+  /**
+   * List of shield objects
+   */
   data: ShieldListResponse;
 }
 
@@ -76,15 +82,30 @@ export interface Shield {
   type?: 'shield';
 }
 
+/**
+ * List of shield objects
+ */
 export type ShieldListResponse = Array<Shield>;
 
 export interface ShieldRegisterParams {
+  /**
+   * The identifier of the shield to register.
+   */
   shield_id: string;
 
+  /**
+   * The parameters of the shield.
+   */
   params?: { [key: string]: unknown } | null;
 
+  /**
+   * The identifier of the provider.
+   */
   provider_id?: string | null;
 
+  /**
+   * The identifier of the shield in the provider.
+   */
   provider_shield_id?: string | null;
 }