llama-stack-client 0.2.16 → 0.2.17-rc1

package/src/resources/routes.ts

@@ -6,7 +6,7 @@ import * as InspectAPI from './inspect';
 
 export class Routes extends APIResource {
   /**
-   * List all routes.
+   * List all available API routes with their methods and implementing providers.
    */
   list(options?: Core.RequestOptions): Core.APIPromise<RouteListResponse> {
     return (
@@ -15,10 +15,19 @@ export class Routes extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of all available API routes.
+ */
 export interface ListRoutesResponse {
+  /**
+   * List of available route information objects
+   */
   data: RouteListResponse;
 }
 
+/**
+ * List of available route information objects
+ */
 export type RouteListResponse = Array<InspectAPI.RouteInfo>;
 
 export declare namespace Routes {

package/src/resources/safety.ts

@@ -5,6 +5,13 @@ import * as Core from '../core';
 import * as Shared from './shared';
 
 export class Safety extends APIResource {
+  /**
+   * Classifies if text and/or image inputs are potentially harmful.
+   */
+  create(body: SafetyCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateResponse> {
+    return this._client.post('/v1/openai/v1/moderations', { body, ...options });
+  }
+
   /**
    * Run a shield.
    */
@@ -13,10 +20,80 @@ export class Safety extends APIResource {
   }
 }
 
+/**
+ * A moderation object.
+ */
+export interface CreateResponse {
+  /**
+   * The unique identifier for the moderation request.
+   */
+  id: string;
+
+  /**
+   * The model used to generate the moderation results.
+   */
+  model: string;
+
+  /**
+   * A list of moderation objects
+   */
+  results: Array<CreateResponse.Result>;
+}
+
+export namespace CreateResponse {
+  /**
+   * A moderation object.
+   */
+  export interface Result {
+    /**
+     * Whether any of the below categories are flagged.
+     */
+    flagged: boolean;
+
+    metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+
+    /**
+     * A list of the categories, and whether they are flagged or not.
+     */
+    categories?: { [key: string]: boolean };
+
+    /**
+     * A list of the categories along with the input type(s) that the score applies to.
+     */
+    category_applied_input_types?: { [key: string]: Array<string> };
+
+    /**
+     * A list of the categories along with their scores as predicted by model.
+     */
+    category_scores?: { [key: string]: number };
+
+    user_message?: string;
+  }
+}
+
+/**
+ * Response from running a safety shield.
+ */
 export interface RunShieldResponse {
+  /**
+   * (Optional) Safety violation detected by the shield, if any
+   */
   violation?: Shared.SafetyViolation;
 }
 
+export interface SafetyCreateParams {
+  /**
+   * Input (or inputs) to classify. Can be a single string, an array of strings, or
+   * an array of multi-modal input objects similar to other models.
+   */
+  input: string | Array<string>;
+
+  /**
+   * The content moderation model you would like to use.
+   */
+  model: string;
+}
+
 export interface SafetyRunShieldParams {
   /**
    * The messages to run the shield on.
@@ -35,5 +112,10 @@ export interface SafetyRunShieldParams {
 }
 
 export declare namespace Safety {
-  export { type RunShieldResponse as RunShieldResponse, type SafetyRunShieldParams as SafetyRunShieldParams };
+  export {
+    type CreateResponse as CreateResponse,
+    type RunShieldResponse as RunShieldResponse,
+    type SafetyCreateParams as SafetyCreateParams,
+    type SafetyRunShieldParams as SafetyRunShieldParams,
+  };
 }

package/src/resources/scoring-functions.ts

@@ -39,6 +39,9 @@ export interface ListScoringFunctionsResponse {
   data: ScoringFunctionListResponse;
 }
 
+/**
+ * A scoring function resource for evaluating model outputs.
+ */
 export interface ScoringFn {
   identifier: string;
 
@@ -48,50 +51,98 @@ export interface ScoringFn {
 
   return_type: Shared.ReturnType;
 
+  /**
+   * The resource type, always scoring_function
+   */
   type: 'scoring_function';
 
   description?: string;
 
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
   params?: ScoringFnParams;
 
   provider_resource_id?: string;
 }
 
+/**
+ * Parameters for LLM-as-judge scoring function configuration.
+ */
 export type ScoringFnParams =
   | ScoringFnParams.LlmAsJudgeScoringFnParams
   | ScoringFnParams.RegexParserScoringFnParams
   | ScoringFnParams.BasicScoringFnParams;
 
 export namespace ScoringFnParams {
+  /**
+   * Parameters for LLM-as-judge scoring function configuration.
+   */
   export interface LlmAsJudgeScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
     aggregation_functions: Array<
       'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
     >;
 
+    /**
+     * Identifier of the LLM model to use as a judge for scoring
+     */
     judge_model: string;
 
+    /**
+     * Regexes to extract the answer from generated response
+     */
     judge_score_regexes: Array<string>;
 
+    /**
+     * The type of scoring function parameters, always llm_as_judge
+     */
     type: 'llm_as_judge';
 
+    /**
+     * (Optional) Custom prompt template for the judge model
+     */
     prompt_template?: string;
   }
 
+  /**
+   * Parameters for regex parser scoring function configuration.
+   */
   export interface RegexParserScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
     aggregation_functions: Array<
       'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
     >;
 
+    /**
+     * Regex to extract the answer from generated response
+     */
     parsing_regexes: Array<string>;
 
+    /**
+     * The type of scoring function parameters, always regex_parser
+     */
     type: 'regex_parser';
   }
 
+  /**
+   * Parameters for basic scoring function configuration.
+   */
   export interface BasicScoringFnParams {
+    /**
+     * Aggregation functions to apply to the scores of each row
+     */
     aggregation_functions: Array<
       'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
     >;
 
+    /**
+     * The type of scoring function parameters, always basic
+     */
     type: 'basic';
   }
 }

package/src/resources/scoring.ts

@@ -34,9 +34,18 @@ export interface ScoringScoreResponse {
   results: { [key: string]: Shared.ScoringResult };
 }
 
+/**
+ * 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;
 }
 

package/src/resources/shared.ts

@@ -105,7 +105,13 @@ export namespace AgentConfig {
   }
 }
 
+/**
+ * Response from a batch completion request.
+ */
 export interface BatchCompletion {
+  /**
+   * List of completion responses, one for each input in the batch
+   */
   batch: Array<InferenceAPI.CompletionResponse>;
 }
 
@@ -123,15 +129,30 @@ export interface ChatCompletionResponse {
    */
   logprobs?: Array<InferenceAPI.TokenLogProbs>;
 
+  /**
+   * (Optional) List of metrics associated with the API response
+   */
   metrics?: Array<ChatCompletionResponse.Metric>;
 }
 
 export namespace ChatCompletionResponse {
+  /**
+   * A metric value included in API responses.
+   */
   export interface Metric {
+    /**
+     * The name of the metric
+     */
     metric: string;
 
+    /**
+     * The numeric value of the metric
+     */
     value: number;
 
+    /**
+     * (Optional) The unit of measurement for the metric value
+     */
     unit?: string;
   }
 }
@@ -166,26 +187,59 @@ export interface CompletionMessage {
   tool_calls?: Array<ToolCall>;
 }
 
+/**
+ * A text content delta for streaming responses.
+ */
 export type ContentDelta = ContentDelta.TextDelta | ContentDelta.ImageDelta | ContentDelta.ToolCallDelta;
 
 export namespace ContentDelta {
+  /**
+   * A text content delta for streaming responses.
+   */
   export interface TextDelta {
+    /**
+     * The incremental text content
+     */
     text: string;
 
+    /**
+     * Discriminator type of the delta. Always "text"
+     */
     type: 'text';
   }
 
+  /**
+   * An image content delta for streaming responses.
+   */
   export interface ImageDelta {
+    /**
+     * The incremental image data as bytes
+     */
     image: string;
 
+    /**
+     * Discriminator type of the delta. Always "image"
+     */
     type: 'image';
   }
 
+  /**
+   * A tool call content delta for streaming responses.
+   */
   export interface ToolCallDelta {
+    /**
+     * Current parsing status of the tool call
+     */
     parse_status: 'started' | 'in_progress' | 'failed' | 'succeeded';
 
+    /**
+     * Either an in-progress tool call string or the final parsed tool call
+     */
     tool_call: Shared.ToolCallOrString;
 
+    /**
+     * Discriminator type of the delta. Always "tool_call"
+     */
     type: 'tool_call';
   }
 }
@@ -259,6 +313,9 @@ export namespace Document {
        * Note that URL could have length limits.
        */
       export interface URL {
+        /**
+         * The URL string pointing to the resource
+         */
         uri: string;
       }
     }
@@ -279,7 +336,13 @@ export namespace Document {
     type: 'text';
   }
 
+  /**
+   * A URL reference to external content.
+   */
   export interface URL {
+    /**
+     * The URL string pointing to the resource
+     */
     uri: string;
   }
 }
@@ -332,6 +395,9 @@ export namespace InterleavedContent {
        * Note that URL could have length limits.
        */
       export interface URL {
+        /**
+         * The URL string pointing to the resource
+         */
         uri: string;
       }
     }
@@ -399,6 +465,9 @@ export namespace InterleavedContentItem {
        * Note that URL could have length limits.
        */
       export interface URL {
+        /**
+         * The URL string pointing to the resource
+         */
         uri: string;
       }
     }
@@ -425,6 +494,9 @@ export namespace InterleavedContentItem {
  */
 export type Message = UserMessage | SystemMessage | ToolResponseMessage | CompletionMessage;
 
+/**
+ * Parameter type for string values.
+ */
 export type ParamType =
   | ParamType.StringType
   | ParamType.NumberType
@@ -438,43 +510,103 @@ export type ParamType =
   | ParamType.AgentTurnInputType;
 
 export namespace ParamType {
+  /**
+   * Parameter type for string values.
+   */
   export interface StringType {
+    /**
+     * Discriminator type. Always "string"
+     */
     type: 'string';
   }
 
+  /**
+   * Parameter type for numeric values.
+   */
   export interface NumberType {
+    /**
+     * Discriminator type. Always "number"
+     */
     type: 'number';
   }
 
+  /**
+   * Parameter type for boolean values.
+   */
   export interface BooleanType {
+    /**
+     * Discriminator type. Always "boolean"
+     */
     type: 'boolean';
   }
 
+  /**
+   * Parameter type for array values.
+   */
   export interface ArrayType {
+    /**
+     * Discriminator type. Always "array"
+     */
     type: 'array';
   }
 
+  /**
+   * Parameter type for object values.
+   */
   export interface ObjectType {
+    /**
+     * Discriminator type. Always "object"
+     */
     type: 'object';
   }
 
+  /**
+   * Parameter type for JSON values.
+   */
   export interface JsonType {
+    /**
+     * Discriminator type. Always "json"
+     */
     type: 'json';
   }
 
+  /**
+   * Parameter type for union values.
+   */
   export interface UnionType {
+    /**
+     * Discriminator type. Always "union"
+     */
     type: 'union';
   }
 
+  /**
+   * Parameter type for chat completion input.
+   */
   export interface ChatCompletionInputType {
+    /**
+     * Discriminator type. Always "chat_completion_input"
+     */
     type: 'chat_completion_input';
   }
 
+  /**
+   * Parameter type for completion input.
+   */
   export interface CompletionInputType {
+    /**
+     * Discriminator type. Always "completion_input"
+     */
     type: 'completion_input';
   }
 
+  /**
+   * Parameter type for agent turn input.
+   */
   export interface AgentTurnInputType {
+    /**
+     * Discriminator type. Always "agent_turn_input"
+     */
     type: 'agent_turn_input';
   }
 }
@@ -525,8 +657,7 @@ export namespace QueryConfig {
   export interface RrfRanker {
     /**
      * The impact factor for RRF scoring. Higher values give more weight to
-     * higher-ranked results. Must be greater than 0. Default of 60 is from the
-     * original RRF paper (Cormack et al., 2009).
+     * higher-ranked results. Must be greater than 0
      */
     impact_factor: number;
 
@@ -553,31 +684,61 @@ export namespace QueryConfig {
   }
 }
 
+/**
+ * Configuration for the default RAG query generator.
+ */
 export type QueryGeneratorConfig =
   | QueryGeneratorConfig.DefaultRagQueryGeneratorConfig
   | QueryGeneratorConfig.LlmragQueryGeneratorConfig;
 
 export namespace QueryGeneratorConfig {
+  /**
+   * Configuration for the default RAG query generator.
+   */
   export interface DefaultRagQueryGeneratorConfig {
+    /**
+     * String separator used to join query terms
+     */
     separator: string;
 
+    /**
+     * Type of query generator, always 'default'
+     */
     type: 'default';
   }
 
+  /**
+   * Configuration for the LLM-based RAG query generator.
+   */
   export interface LlmragQueryGeneratorConfig {
+    /**
+     * Name of the language model to use for query generation
+     */
     model: string;
 
+    /**
+     * Template string for formatting the query generation prompt
+     */
     template: string;
 
+    /**
+     * Type of query generator, always 'llm'
+     */
     type: 'llm';
   }
 }
 
+/**
+ * Result of a RAG query containing retrieved content and metadata.
+ */
 export interface QueryResult {
+  /**
+   * Additional metadata about the query result
+   */
   metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
   /**
-   * A image content item
+   * (Optional) The retrieved content from the query
    */
   content?: InterleavedContent;
 }
@@ -634,11 +795,24 @@ export interface ReturnType {
     | 'agent_turn_input';
 }
 
+/**
+ * Details of a safety violation detected by content moderation.
+ */
 export interface SafetyViolation {
+  /**
+   * Additional metadata including specific violation codes for debugging and
+   * telemetry
+   */
   metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * Severity level of the violation
+   */
   violation_level: 'info' | 'warn' | 'error';
 
+  /**
+   * (Optional) Message to convey to the user about the violation
+   */
   user_message?: string;
 }
 
@@ -675,21 +849,50 @@ export interface SamplingParams {
 }
 
 export namespace SamplingParams {
+  /**
+   * Greedy sampling strategy that selects the highest probability token at each
+   * step.
+   */
   export interface GreedySamplingStrategy {
+    /**
+     * Must be "greedy" to identify this sampling strategy
+     */
     type: 'greedy';
   }
 
+  /**
+   * Top-p (nucleus) sampling strategy that samples from the smallest set of tokens
+   * with cumulative probability >= p.
+   */
   export interface TopPSamplingStrategy {
+    /**
+     * Must be "top_p" to identify this sampling strategy
+     */
     type: 'top_p';
 
+    /**
+     * Controls randomness in sampling. Higher values increase randomness
+     */
     temperature?: number;
 
+    /**
+     * Cumulative probability threshold for nucleus sampling. Defaults to 0.95
+     */
     top_p?: number;
   }
 
+  /**
+   * 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';
   }
 }
@@ -746,6 +949,9 @@ export interface ToolCall {
   arguments_json?: string;
 }
 
+/**
+ * Either an in-progress tool call string or the final parsed tool call
+ */
 export type ToolCallOrString = string | ToolCall;
 
 export interface ToolParamDefinition {

package/src/resources/shields.ts

@@ -33,15 +33,21 @@ export interface ListShieldsResponse {
 }
 
 /**
- * A safety shield resource that can be used to check content
+ * A safety shield resource that can be used to check content.
  */
 export interface Shield {
   identifier: string;
 
   provider_id: string;
 
+  /**
+   * The resource type, always shield
+   */
   type: 'shield';
 
+  /**
+   * (Optional) Configuration parameters for the shield
+   */
   params?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
   provider_resource_id?: string;