llama-stack-client 0.2.7 → 0.2.8-rc2

package/src/resources/scoring-functions.ts

@@ -5,10 +5,16 @@ import * as Core from '../core';
 import * as Shared from './shared';
 
 export class ScoringFunctions extends APIResource {
+  /**
+   * Get a scoring function by its ID.
+   */
   retrieve(scoringFnId: string, options?: Core.RequestOptions): Core.APIPromise<ScoringFn> {
     return this._client.get(`/v1/scoring-functions/${scoringFnId}`, options);
   }
 
+  /**
+   * List all scoring functions.
+   */
   list(options?: Core.RequestOptions): Core.APIPromise<ScoringFunctionListResponse> {
     return (
       this._client.get('/v1/scoring-functions', options) as Core.APIPromise<{
@@ -17,6 +23,9 @@ export class ScoringFunctions extends APIResource {
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Register a scoring function.
+   */
   register(body: ScoringFunctionRegisterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/scoring-functions', {
       body,
@@ -37,8 +46,6 @@ export interface ScoringFn {
 
   provider_id: string;
 
-  provider_resource_id: string;
-
   return_type: Shared.ReturnType;
 
   type: 'scoring_function';
@@ -46,6 +53,8 @@ export interface ScoringFn {
   description?: string;
 
   params?: ScoringFnParams;
+
+  provider_resource_id?: string;
 }
 
 export type ScoringFnParams =
@@ -55,51 +64,67 @@ export type ScoringFnParams =
 
 export namespace ScoringFnParams {
   export interface LlmAsJudgeScoringFnParams {
-    judge_model: string;
-
-    type: 'llm_as_judge';
-
-    aggregation_functions?: Array<
+    aggregation_functions: Array<
       'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
     >;
 
-    judge_score_regexes?: Array<string>;
+    judge_model: string;
+
+    judge_score_regexes: Array<string>;
+
+    type: 'llm_as_judge';
 
     prompt_template?: string;
   }
 
   export interface RegexParserScoringFnParams {
-    type: 'regex_parser';
-
-    aggregation_functions?: Array<
+    aggregation_functions: Array<
       'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
     >;
 
-    parsing_regexes?: Array<string>;
+    parsing_regexes: Array<string>;
+
+    type: 'regex_parser';
   }
 
   export interface BasicScoringFnParams {
-    type: 'basic';
-
-    aggregation_functions?: Array<
+    aggregation_functions: Array<
       'average' | 'weighted_average' | 'median' | 'categorical_count' | 'accuracy'
     >;
+
+    type: 'basic';
   }
 }
 
 export type ScoringFunctionListResponse = Array<ScoringFn>;
 
 export interface ScoringFunctionRegisterParams {
+  /**
+   * The description of the scoring function.
+   */
   description: string;
 
   return_type: Shared.ReturnType;
 
+  /**
+   * The ID of the scoring function to register.
+   */
   scoring_fn_id: string;
 
+  /**
+   * The parameters for the scoring function for benchmark eval, these can be
+   * overridden for app eval.
+   */
   params?: ScoringFnParams;
 
+  /**
+   * The ID of the provider to use for the scoring function.
+   */
   provider_id?: string;
 
+  /**
+   * The ID of the provider scoring function to use for the scoring function.
+   */
   provider_scoring_fn_id?: string;
 }
 

package/src/resources/scoring.ts

@@ -13,6 +13,9 @@ export class Scoring extends APIResource {
     return this._client.post('/v1/scoring/score', { body, ...options });
   }
 
+  /**
+   * Score a batch of rows.
+   */
   scoreBatch(
     body: ScoringScoreBatchParams,
     options?: Core.RequestOptions,
@@ -50,10 +53,19 @@ export interface ScoringScoreParams {
 }
 
 export interface ScoringScoreBatchParams {
+  /**
+   * The ID of the dataset to score.
+   */
   dataset_id: string;
 
+  /**
+   * Whether to save the results to a dataset.
+   */
   save_results_dataset: boolean;
 
+  /**
+   * The scoring functions to use for the scoring.
+   */
   scoring_functions: Record<string, ScoringFunctionsAPI.ScoringFnParams | null>;
 }
 

package/src/resources/shared.ts

@@ -479,12 +479,37 @@ export namespace ParamType {
   }
 }
 
+/**
+ * Configuration for the RAG query generation.
+ */
 export interface QueryConfig {
+  /**
+   * Template for formatting each retrieved chunk in the context. Available
+   * placeholders: {index} (1-based chunk ordinal), {chunk.content} (chunk content
+   * string), {metadata} (chunk metadata dict). Default: "Result {index}\nContent:
+   * {chunk.content}\nMetadata: {metadata}\n"
+   */
+  chunk_template: string;
+
+  /**
+   * Maximum number of chunks to retrieve.
+   */
   max_chunks: number;
 
+  /**
+   * Maximum number of tokens in the context.
+   */
   max_tokens_in_context: number;
 
+  /**
+   * Configuration for the query generator.
+   */
   query_generator_config: QueryGeneratorConfig;
+
+  /**
+   * Search mode for retrieval—either "vector" or "keyword". Default "vector".
+   */
+  mode?: string;
 }
 
 export type QueryGeneratorConfig =

package/src/resources/shields.ts

@@ -4,16 +4,25 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 
 export class Shields extends APIResource {
+  /**
+   * Get a shield by its identifier.
+   */
   retrieve(identifier: string, options?: Core.RequestOptions): Core.APIPromise<Shield> {
     return this._client.get(`/v1/shields/${identifier}`, options);
   }
 
+  /**
+   * List all shields.
+   */
   list(options?: Core.RequestOptions): Core.APIPromise<ShieldListResponse> {
     return (
       this._client.get('/v1/shields', options) as Core.APIPromise<{ data: ShieldListResponse }>
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Register a shield.
+   */
   register(body: ShieldRegisterParams, options?: Core.RequestOptions): Core.APIPromise<Shield> {
     return this._client.post('/v1/shields', { body, ...options });
   }
@@ -31,22 +40,34 @@ export interface Shield {
 
   provider_id: string;
 
-  provider_resource_id: string;
-
   type: 'shield';
 
   params?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  provider_resource_id?: string;
 }
 
 export type ShieldListResponse = Array<Shield>;
 
 export interface ShieldRegisterParams {
+  /**
+   * The identifier of the shield to register.
+   */
   shield_id: string;
 
+  /**
+   * The parameters of the shield.
+   */
   params?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
+  /**
+   * The identifier of the provider.
+   */
   provider_id?: string;
 
+  /**
+   * The identifier of the shield in the provider.
+   */
   provider_shield_id?: string;
 }
 

package/src/resources/telemetry.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 
 export class Telemetry extends APIResource {
+  /**
+   * Get a span by its ID.
+   */
   getSpan(
     traceId: string,
     spanId: string,
@@ -12,6 +15,9 @@ export class Telemetry extends APIResource {
     return this._client.get(`/v1/telemetry/traces/${traceId}/spans/${spanId}`, options);
   }
 
+  /**
+   * Get a span tree by its ID.
+   */
   getSpanTree(
     spanId: string,
     body: TelemetryGetSpanTreeParams,
@@ -24,10 +30,16 @@ export class Telemetry extends APIResource {
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Get a trace by its ID.
+   */
   getTrace(traceId: string, options?: Core.RequestOptions): Core.APIPromise<Trace> {
     return this._client.get(`/v1/telemetry/traces/${traceId}`, options);
   }
 
+  /**
+   * Log an event.
+   */
   logEvent(body: TelemetryLogEventParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/telemetry/events', {
       body,
@@ -36,6 +48,9 @@ export class Telemetry extends APIResource {
     });
   }
 
+  /**
+   * Query spans.
+   */
   querySpans(
     body: TelemetryQuerySpansParams,
     options?: Core.RequestOptions,
@@ -47,6 +62,9 @@ export class Telemetry extends APIResource {
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Query traces.
+   */
   queryTraces(
     body: TelemetryQueryTracesParams,
     options?: Core.RequestOptions,
@@ -58,6 +76,9 @@ export class Telemetry extends APIResource {
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Save spans to a dataset.
+   */
   saveSpansToDataset(
     body: TelemetrySaveSpansToDatasetParams,
     options?: Core.RequestOptions,
@@ -219,42 +240,87 @@ export namespace TelemetryQuerySpansResponse {
 export type TelemetryQueryTracesResponse = Array<Trace>;
 
 export interface TelemetryGetSpanTreeParams {
+  /**
+   * The attributes to return in the tree.
+   */
   attributes_to_return?: Array<string>;
 
+  /**
+   * The maximum depth of the tree.
+   */
   max_depth?: number;
 }
 
 export interface TelemetryLogEventParams {
+  /**
+   * The event to log.
+   */
   event: Event;
 
+  /**
+   * The time to live of the event.
+   */
   ttl_seconds: number;
 }
 
 export interface TelemetryQuerySpansParams {
+  /**
+   * The attribute filters to apply to the spans.
+   */
   attribute_filters: Array<QueryCondition>;
 
+  /**
+   * The attributes to return in the spans.
+   */
   attributes_to_return: Array<string>;
 
+  /**
+   * The maximum depth of the tree.
+   */
   max_depth?: number;
 }
 
 export interface TelemetryQueryTracesParams {
+  /**
+   * The attribute filters to apply to the traces.
+   */
   attribute_filters?: Array<QueryCondition>;
 
+  /**
+   * The limit of traces to return.
+   */
   limit?: number;
 
+  /**
+   * The offset of the traces to return.
+   */
   offset?: number;
 
+  /**
+   * The order by of the traces to return.
+   */
   order_by?: Array<string>;
 }
 
 export interface TelemetrySaveSpansToDatasetParams {
+  /**
+   * The attribute filters to apply to the spans.
+   */
   attribute_filters: Array<QueryCondition>;
 
+  /**
+   * The attributes to save to the dataset.
+   */
   attributes_to_save: Array<string>;
 
+  /**
+   * The ID of the dataset to save the spans to.
+   */
   dataset_id: string;
 
+  /**
+   * The maximum depth of the tree.
+   */
   max_depth?: number;
 }
 

package/src/resources/tool-runtime/rag-tool.ts

@@ -40,6 +40,9 @@ export interface RagToolQueryParams {
 
   vector_db_ids: Array<string>;
 
+  /**
+   * Configuration for the RAG query generation.
+   */
   query_config?: Shared.QueryConfig;
 }
 

package/src/resources/tool-runtime/tool-runtime.ts

@@ -11,7 +11,7 @@ export class ToolRuntime extends APIResource {
   ragTool: RagToolAPI.RagTool = new RagToolAPI.RagTool(this._client);
 
   /**
-   * Run a tool with the given arguments
+   * Run a tool with the given arguments.
    */
   invokeTool(
     body: ToolRuntimeInvokeToolParams,
@@ -20,6 +20,9 @@ export class ToolRuntime extends APIResource {
     return this._client.post('/v1/tool-runtime/invoke', { body, ...options });
   }
 
+  /**
+   * List all tools in the runtime.
+   */
   listTools(
     query?: ToolRuntimeListToolsParams,
     options?: Core.RequestOptions,
@@ -80,18 +83,33 @@ export interface ToolInvocationResult {
 export type ToolRuntimeListToolsResponse = Array<ToolDef>;
 
 export interface ToolRuntimeInvokeToolParams {
+  /**
+   * A dictionary of arguments to pass to the tool.
+   */
   kwargs: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
+  /**
+   * The name of the tool to invoke.
+   */
   tool_name: string;
 }
 
 export interface ToolRuntimeListToolsParams {
+  /**
+   * The MCP endpoint to use for the tool group.
+   */
   mcp_endpoint?: ToolRuntimeListToolsParams.McpEndpoint;
 
+  /**
+   * The ID of the tool group to list tools for.
+   */
   tool_group_id?: string;
 }
 
 export namespace ToolRuntimeListToolsParams {
+  /**
+   * The MCP endpoint to use for the tool group.
+   */
   export interface McpEndpoint {
     uri: string;
   }

package/src/resources/toolgroups.ts

@@ -5,7 +5,7 @@ import * as Core from '../core';
 
 export class Toolgroups extends APIResource {
   /**
-   * List tool groups with optional provider
+   * List tool groups with optional provider.
    */
   list(options?: Core.RequestOptions): Core.APIPromise<ToolgroupListResponse> {
     return (
@@ -13,12 +13,15 @@ export class Toolgroups extends APIResource {
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Get a tool group by its ID.
+   */
   get(toolgroupId: string, options?: Core.RequestOptions): Core.APIPromise<ToolGroup> {
     return this._client.get(`/v1/toolgroups/${toolgroupId}`, options);
   }
 
   /**
-   * Register a tool group
+   * Register a tool group.
    */
   register(body: ToolgroupRegisterParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/toolgroups', {
@@ -29,7 +32,7 @@ export class Toolgroups extends APIResource {
   }
 
   /**
-   * Unregister a tool group
+   * Unregister a tool group.
    */
   unregister(toolgroupId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v1/toolgroups/${toolgroupId}`, {
@@ -48,13 +51,13 @@ export interface ToolGroup {
 
   provider_id: string;
 
-  provider_resource_id: string;
-
   type: 'tool_group';
 
   args?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
   mcp_endpoint?: ToolGroup.McpEndpoint;
+
+  provider_resource_id?: string;
 }
 
 export namespace ToolGroup {
@@ -66,16 +69,31 @@ export namespace ToolGroup {
 export type ToolgroupListResponse = Array<ToolGroup>;
 
 export interface ToolgroupRegisterParams {
+  /**
+   * The ID of the provider to use for the tool group.
+   */
   provider_id: string;
 
+  /**
+   * The ID of the tool group to register.
+   */
   toolgroup_id: string;
 
+  /**
+   * A dictionary of arguments to pass to the tool group.
+   */
   args?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
+  /**
+   * The MCP endpoint to use for the tool group.
+   */
   mcp_endpoint?: ToolgroupRegisterParams.McpEndpoint;
 }
 
 export namespace ToolgroupRegisterParams {
+  /**
+   * The MCP endpoint to use for the tool group.
+   */
   export interface McpEndpoint {
     uri: string;
   }

package/src/resources/tools.ts

@@ -6,7 +6,7 @@ import * as Core from '../core';
 
 export class Tools extends APIResource {
   /**
-   * List tools with optional tool group
+   * List tools with optional tool group.
    */
   list(query?: ToolListParams, options?: Core.RequestOptions): Core.APIPromise<ToolListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<ToolListResponse>;
@@ -22,6 +22,9 @@ export class Tools extends APIResource {
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Get a tool by its name.
+   */
   get(toolName: string, options?: Core.RequestOptions): Core.APIPromise<Tool> {
     return this._client.get(`/v1/tools/${toolName}`, options);
   }
@@ -40,8 +43,6 @@ export interface Tool {
 
   provider_id: string;
 
-  provider_resource_id: string;
-
   tool_host: 'distribution' | 'client' | 'model_context_protocol';
 
   toolgroup_id: string;
@@ -49,6 +50,8 @@ export interface Tool {
   type: 'tool';
 
   metadata?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  provider_resource_id?: string;
 }
 
 export namespace Tool {
@@ -68,6 +71,9 @@ export namespace Tool {
 export type ToolListResponse = Array<Tool>;
 
 export interface ToolListParams {
+  /**
+   * The ID of the tool group to list tools for.
+   */
   toolgroup_id?: string;
 }
 

package/src/resources/vector-dbs.ts

@@ -4,16 +4,25 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 
 export class VectorDBs extends APIResource {
+  /**
+   * Get a vector database by its identifier.
+   */
   retrieve(vectorDBId: string, options?: Core.RequestOptions): Core.APIPromise<VectorDBRetrieveResponse> {
     return this._client.get(`/v1/vector-dbs/${vectorDBId}`, options);
   }
 
+  /**
+   * List all vector databases.
+   */
   list(options?: Core.RequestOptions): Core.APIPromise<VectorDBListResponse> {
     return (
       this._client.get('/v1/vector-dbs', options) as Core.APIPromise<{ data: VectorDBListResponse }>
     )._thenUnwrap((obj) => obj.data);
   }
 
+  /**
+   * Register a vector database.
+   */
   register(
     body: VectorDBRegisterParams,
     options?: Core.RequestOptions,
@@ -21,6 +30,9 @@ export class VectorDBs extends APIResource {
     return this._client.post('/v1/vector-dbs', { body, ...options });
   }
 
+  /**
+   * Unregister a vector database.
+   */
   unregister(vectorDBId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v1/vector-dbs/${vectorDBId}`, {
       ...options,
@@ -42,9 +54,9 @@ export interface VectorDBRetrieveResponse {
 
   provider_id: string;
 
-  provider_resource_id: string;
-
   type: 'vector_db';
+
+  provider_resource_id?: string;
 }
 
 export type VectorDBListResponse = Array<VectorDBListResponse.VectorDBListResponseItem>;
@@ -59,9 +71,9 @@ export namespace VectorDBListResponse {
 
     provider_id: string;
 
-    provider_resource_id: string;
-
     type: 'vector_db';
+
+    provider_resource_id?: string;
   }
 }
 
@@ -74,20 +86,35 @@ export interface VectorDBRegisterResponse {
 
   provider_id: string;
 
-  provider_resource_id: string;
-
   type: 'vector_db';
+
+  provider_resource_id?: string;
 }
 
 export interface VectorDBRegisterParams {
+  /**
+   * The embedding model to use.
+   */
   embedding_model: string;
 
+  /**
+   * The identifier of the vector database to register.
+   */
   vector_db_id: string;
 
+  /**
+   * The dimension of the embedding model.
+   */
   embedding_dimension?: number;
 
+  /**
+   * The identifier of the provider.
+   */
   provider_id?: string;
 
+  /**
+   * The identifier of the vector database in the provider.
+   */
   provider_vector_db_id?: string;
 }