llama-stack-client 0.1.5 → 0.1.6

package/src/resources/agents/agents.ts

@@ -33,10 +33,16 @@ export class Agents extends APIResource {
   steps: StepsAPI.Steps = new StepsAPI.Steps(this._client);
   turn: TurnAPI.TurnResource = new TurnAPI.TurnResource(this._client);
 
+  /**
+   * Create an agent with the given configuration.
+   */
   create(body: AgentCreateParams, options?: Core.RequestOptions): Core.APIPromise<AgentCreateResponse> {
     return this._client.post('/v1/agents', { body, ...options });
   }
 
+  /**
+   * Delete an agent by its ID.
+   */
   delete(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v1/agents/${agentId}`, {
       ...options,
@@ -45,69 +51,141 @@ export class Agents extends APIResource {
   }
 }
 
+/**
+ * An inference step in an agent turn.
+ */
 export interface InferenceStep {
   /**
-   * A message containing the model's (assistant) response in a chat conversation.
+   * The response from the LLM.
    */
   model_response: Shared.CompletionMessage;
 
+  /**
+   * The ID of the step.
+   */
   step_id: string;
 
   step_type: 'inference';
 
+  /**
+   * The ID of the turn.
+   */
   turn_id: string;
 
+  /**
+   * The time the step completed.
+   */
   completed_at?: string;
 
+  /**
+   * The time the step started.
+   */
   started_at?: string;
 }
 
+/**
+ * A memory retrieval step in an agent turn.
+ */
 export interface MemoryRetrievalStep {
   /**
-   * A image content item
+   * The context retrieved from the vector databases.
    */
   inserted_context: Shared.InterleavedContent;
 
+  /**
+   * The ID of the step.
+   */
   step_id: string;
 
   step_type: 'memory_retrieval';
 
+  /**
+   * The ID of the turn.
+   */
   turn_id: string;
 
+  /**
+   * The IDs of the vector databases to retrieve context from.
+   */
   vector_db_ids: string;
 
+  /**
+   * The time the step completed.
+   */
   completed_at?: string;
 
+  /**
+   * The time the step started.
+   */
   started_at?: string;
 }
 
+/**
+ * A shield call step in an agent turn.
+ */
 export interface ShieldCallStep {
+  /**
+   * The ID of the step.
+   */
   step_id: string;
 
   step_type: 'shield_call';
 
+  /**
+   * The ID of the turn.
+   */
   turn_id: string;
 
+  /**
+   * The time the step completed.
+   */
   completed_at?: string;
 
+  /**
+   * The time the step started.
+   */
   started_at?: string;
 
+  /**
+   * The violation from the shield call.
+   */
   violation?: Shared.SafetyViolation;
 }
 
+/**
+ * A tool execution step in an agent turn.
+ */
 export interface ToolExecutionStep {
+  /**
+   * The ID of the step.
+   */
   step_id: string;
 
   step_type: 'tool_execution';
 
+  /**
+   * The tool calls to execute.
+   */
   tool_calls: Array<Shared.ToolCall>;
 
+  /**
+   * The tool responses from the tool calls.
+   */
   tool_responses: Array<ToolResponse>;
 
+  /**
+   * The ID of the turn.
+   */
   turn_id: string;
 
+  /**
+   * The time the step completed.
+   */
   completed_at?: string;
 
+  /**
+   * The time the step started.
+   */
   started_at?: string;
 }
 
@@ -129,6 +207,9 @@ export interface AgentCreateResponse {
 }
 
 export interface AgentCreateParams {
+  /**
+   * The configuration for the agent.
+   */
   agent_config: Shared.AgentConfig;
 }
 

package/src/resources/agents/session.ts

@@ -6,6 +6,9 @@ import * as Core from '../../core';
 import * as TurnAPI from './turn';
 
 export class SessionResource extends APIResource {
+  /**
+   * Create a new session for an agent.
+   */
   create(
     agentId: string,
     body: SessionCreateParams,
@@ -14,6 +17,9 @@ export class SessionResource extends APIResource {
     return this._client.post(`/v1/agents/${agentId}/session`, { body, ...options });
   }
 
+  /**
+   * Retrieve an agent session by its ID.
+   */
   retrieve(
     agentId: string,
     sessionId: string,
@@ -33,6 +39,9 @@ export class SessionResource extends APIResource {
     return this._client.get(`/v1/agents/${agentId}/session/${sessionId}`, { query, ...options });
   }
 
+  /**
+   * Delete an agent session by its ID.
+   */
   delete(agentId: string, sessionId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v1/agents/${agentId}/session/${sessionId}`, {
       ...options,
@@ -59,10 +68,16 @@ export interface SessionCreateResponse {
 }
 
 export interface SessionCreateParams {
+  /**
+   * The name of the session to create.
+   */
   session_name: string;
 }
 
 export interface SessionRetrieveParams {
+  /**
+   * (Optional) List of turn IDs to filter the session by.
+   */
   turn_ids?: Array<string>;
 }
 

package/src/resources/agents/steps.ts

@@ -5,6 +5,9 @@ import * as Core from '../../core';
 import * as AgentsAPI from './agents';
 
 export class Steps extends APIResource {
+  /**
+   * Retrieve an agent step by its ID.
+   */
   retrieve(
     agentId: string,
     sessionId: string,
@@ -20,6 +23,9 @@ export class Steps extends APIResource {
 }
 
 export interface StepRetrieveResponse {
+  /**
+   * An inference step in an agent turn.
+   */
   step:
     | AgentsAPI.InferenceStep
     | AgentsAPI.ToolExecutionStep

package/src/resources/agents/turn.ts

@@ -9,6 +9,9 @@ import * as AgentsAPI from './agents';
 import { Stream } from '../../streaming';
 
 export class TurnResource extends APIResource {
+  /**
+   * Create a new turn for an agent.
+   */
   create(
     agentId: string,
     sessionId: string,
@@ -40,6 +43,9 @@ export class TurnResource extends APIResource {
     }) as APIPromise<Turn> | APIPromise<Stream<AgentTurnResponseStreamChunk>>;
   }
 
+  /**
+   * Retrieve an agent turn by its ID.
+   */
   retrieve(
     agentId: string,
     sessionId: string,
@@ -128,9 +134,12 @@ export interface Turn {
 }
 
 export namespace Turn {
+  /**
+   * An attachment to an agent turn.
+   */
   export interface OutputAttachment {
     /**
-     * A image content item
+     * The content of the attachment.
      */
     content:
       | string
@@ -139,6 +148,9 @@ export namespace Turn {
       | Array<Shared.InterleavedContentItem>
       | OutputAttachment.URL;
 
+    /**
+     * The MIME type of the attachment.
+     */
     mime_type: string;
   }
 
@@ -225,6 +237,9 @@ export namespace TurnResponseEventPayload {
 
     step_id: string;
 
+    /**
+     * Type of the step in an agent turn.
+     */
     step_type: 'inference' | 'tool_execution' | 'shield_call' | 'memory_retrieval';
 
     metadata?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
@@ -237,12 +252,18 @@ export namespace TurnResponseEventPayload {
 
     step_id: string;
 
+    /**
+     * Type of the step in an agent turn.
+     */
     step_type: 'inference' | 'tool_execution' | 'shield_call' | 'memory_retrieval';
   }
 
   export interface AgentTurnResponseStepCompletePayload {
     event_type: 'step_complete';
 
+    /**
+     * An inference step in an agent turn.
+     */
     step_details:
       | AgentsAPI.InferenceStep
       | AgentsAPI.ToolExecutionStep
@@ -251,6 +272,9 @@ export namespace TurnResponseEventPayload {
 
     step_id: string;
 
+    /**
+     * Type of the step in an agent turn.
+     */
     step_type: 'inference' | 'tool_execution' | 'shield_call' | 'memory_retrieval';
   }
 
@@ -282,26 +306,42 @@ export namespace TurnResponseEventPayload {
 export type TurnCreateParams = TurnCreateParamsNonStreaming | TurnCreateParamsStreaming;
 
 export interface TurnCreateParamsBase {
+  /**
+   * List of messages to start the turn with.
+   */
   messages: Array<Shared.UserMessage | Shared.ToolResponseMessage>;
 
-  allow_turn_resume?: boolean;
-
+  /**
+   * (Optional) List of documents to create the turn with.
+   */
   documents?: Array<TurnCreateParams.Document>;
 
+  /**
+   * (Optional) If True, generate an SSE event stream of the response. Defaults to
+   * False.
+   */
   stream?: boolean;
 
   /**
-   * Configuration for tool use.
+   * (Optional) The tool configuration to create the turn with, will be used to
+   * override the agent's tool_config.
    */
   tool_config?: TurnCreateParams.ToolConfig;
 
+  /**
+   * (Optional) List of toolgroups to create the turn with, will be used in addition
+   * to the agent's config toolgroups for the request.
+   */
   toolgroups?: Array<string | TurnCreateParams.AgentToolGroupWithArgs>;
 }
 
 export namespace TurnCreateParams {
+  /**
+   * A document to be used by an agent.
+   */
   export interface Document {
     /**
-     * A image content item
+     * The content of the document.
      */
     content:
       | string
@@ -310,6 +350,9 @@ export namespace TurnCreateParams {
       | Array<Shared.InterleavedContentItem>
       | Document.URL;
 
+    /**
+     * The MIME type of the document.
+     */
     mime_type: string;
   }
 
@@ -378,7 +421,8 @@ export namespace TurnCreateParams {
   }
 
   /**
-   * Configuration for tool use.
+   * (Optional) The tool configuration to create the turn with, will be used to
+   * override the agent's tool_config.
    */
   export interface ToolConfig {
     /**
@@ -419,10 +463,18 @@ export namespace TurnCreateParams {
 }
 
 export interface TurnCreateParamsNonStreaming extends TurnCreateParamsBase {
+  /**
+   * (Optional) If True, generate an SSE event stream of the response. Defaults to
+   * False.
+   */
   stream?: false;
 }
 
 export interface TurnCreateParamsStreaming extends TurnCreateParamsBase {
+  /**
+   * (Optional) If True, generate an SSE event stream of the response. Defaults to
+   * False.
+   */
   stream: true;
 }
 
@@ -430,9 +482,10 @@ export type TurnResumeParams = TurnResumeParamsNonStreaming | TurnResumeParamsSt
 
 export interface TurnResumeParamsBase {
   /**
-   * The tool call responses to resume the turn with.
+   * The tool call responses to resume the turn with. NOTE: ToolResponseMessage will
+   * be deprecated. Use ToolResponse.
    */
-  tool_responses: Array<Shared.ToolResponseMessage>;
+  tool_responses: Array<AgentsAPI.ToolResponse> | Array<Shared.ToolResponseMessage>;
 
   /**
    * Whether to stream the response.

package/src/resources/datasetio.ts

@@ -12,6 +12,9 @@ export class Datasetio extends APIResource {
     });
   }
 
+  /**
+   * Get a paginated list of rows from a dataset.
+   */
   getRowsPaginated(
     query: DatasetioGetRowsPaginatedParams,
     options?: Core.RequestOptions,
@@ -20,11 +23,23 @@ export class Datasetio extends APIResource {
   }
 }
 
+/**
+ * A paginated list of rows from a dataset.
+ */
 export interface PaginatedRowsResult {
+  /**
+   * The rows in the current page.
+   */
   rows: Array<Record<string, boolean | number | string | Array<unknown> | unknown | null>>;
 
+  /**
+   * The total number of rows in the dataset.
+   */
   total_count: number;
 
+  /**
+   * The token to get the next page of rows.
+   */
   next_page_token?: string;
 }
 
@@ -35,12 +50,24 @@ export interface DatasetioAppendRowsParams {
 }
 
 export interface DatasetioGetRowsPaginatedParams {
+  /**
+   * The ID of the dataset to get the rows from.
+   */
   dataset_id: string;
 
+  /**
+   * The number of rows to get per page.
+   */
   rows_in_page: number;
 
+  /**
+   * (Optional) A condition to filter the rows by.
+   */
   filter_condition?: string;
 
+  /**
+   * The token to get the next page of rows.
+   */
   page_token?: string;
 }
 

package/src/resources/eval/eval.ts

@@ -10,6 +10,9 @@ import { JobStatusResponse, Jobs } from './jobs';
 export class Eval extends APIResource {
   jobs: JobsAPI.Jobs = new JobsAPI.Jobs(this._client);
 
+  /**
+   * Evaluate a list of rows on a benchmark.
+   */
   evaluateRows(
     benchmarkId: string,
     body: EvalEvaluateRowsParams,
@@ -18,6 +21,9 @@ export class Eval extends APIResource {
     return this._client.post(`/v1/eval/benchmarks/${benchmarkId}/evaluations`, { body, ...options });
   }
 
+  /**
+   * Evaluate a list of rows on a benchmark.
+   */
   evaluateRowsAlpha(
     benchmarkId: string,
     body: EvalEvaluateRowsAlphaParams,
@@ -26,10 +32,16 @@ export class Eval extends APIResource {
     return this._client.post(`/v1/eval/benchmarks/${benchmarkId}/evaluations`, { body, ...options });
   }
 
+  /**
+   * Run an evaluation on a benchmark.
+   */
   runEval(benchmarkId: string, body: EvalRunEvalParams, options?: Core.RequestOptions): Core.APIPromise<Job> {
     return this._client.post(`/v1/eval/benchmarks/${benchmarkId}/jobs`, { body, ...options });
   }
 
+  /**
+   * Run an evaluation on a benchmark.
+   */
   runEvalAlpha(
     benchmarkId: string,
     body: EvalRunEvalAlphaParams,
@@ -39,40 +51,81 @@ export class Eval extends APIResource {
   }
 }
 
+/**
+ * A benchmark configuration for evaluation.
+ */
 export interface BenchmarkConfig {
+  /**
+   * The candidate to evaluate.
+   */
   eval_candidate: EvalCandidate;
 
+  /**
+   * Map between scoring function id and parameters for each scoring function you
+   * want to run
+   */
   scoring_params: Record<string, ScoringFunctionsAPI.ScoringFnParams>;
 
+  /**
+   * (Optional) The number of examples to evaluate. If not provided, all examples in
+   * the dataset will be evaluated
+   */
   num_examples?: number;
 }
 
+/**
+ * A model candidate for evaluation.
+ */
 export type EvalCandidate = EvalCandidate.ModelCandidate | EvalCandidate.AgentCandidate;
 
 export namespace EvalCandidate {
+  /**
+   * A model candidate for evaluation.
+   */
   export interface ModelCandidate {
+    /**
+     * The model ID to evaluate.
+     */
     model: string;
 
+    /**
+     * The sampling parameters for the model.
+     */
     sampling_params: Shared.SamplingParams;
 
     type: 'model';
 
     /**
-     * A system message providing instructions or context to the model.
+     * (Optional) The system message providing instructions or context to the model.
      */
     system_message?: Shared.SystemMessage;
   }
 
+  /**
+   * An agent candidate for evaluation.
+   */
   export interface AgentCandidate {
+    /**
+     * The configuration for the agent candidate.
+     */
     config: Shared.AgentConfig;
 
     type: 'agent';
   }
 }
 
+/**
+ * The response from an evaluation.
+ */
 export interface EvaluateResponse {
+  /**
+   * The generations from the evaluation.
+   */
   generations: Array<Record<string, boolean | number | string | Array<unknown> | unknown | null>>;
 
+  /**
+   * The scores from the evaluation.
+   */
   scores: Record<string, Shared.ScoringResult>;
 }
 
@@ -81,27 +134,51 @@ export interface Job {
 }
 
 export interface EvalEvaluateRowsParams {
+  /**
+   * The configuration for the benchmark.
+   */
+  benchmark_config: BenchmarkConfig;
+
+  /**
+   * The rows to evaluate.
+   */
   input_rows: Array<Record<string, boolean | number | string | Array<unknown> | unknown | null>>;
 
+  /**
+   * The scoring functions to use for the evaluation.
+   */
   scoring_functions: Array<string>;
-
-  task_config: BenchmarkConfig;
 }
 
 export interface EvalEvaluateRowsAlphaParams {
+  /**
+   * The configuration for the benchmark.
+   */
+  benchmark_config: BenchmarkConfig;
+
+  /**
+   * The rows to evaluate.
+   */
   input_rows: Array<Record<string, boolean | number | string | Array<unknown> | unknown | null>>;
 
+  /**
+   * The scoring functions to use for the evaluation.
+   */
   scoring_functions: Array<string>;
-
-  task_config: BenchmarkConfig;
 }
 
 export interface EvalRunEvalParams {
-  task_config: BenchmarkConfig;
+  /**
+   * The configuration for the benchmark.
+   */
+  benchmark_config: BenchmarkConfig;
 }
 
 export interface EvalRunEvalAlphaParams {
-  task_config: BenchmarkConfig;
+  /**
+   * The configuration for the benchmark.
+   */
+  benchmark_config: BenchmarkConfig;
 }
 
 Eval.Jobs = Jobs;

package/src/resources/eval/jobs.ts

@@ -5,6 +5,9 @@ import * as Core from '../../core';
 import * as EvalAPI from './eval';
 
 export class Jobs extends APIResource {
+  /**
+   * Get the result of a job.
+   */
   retrieve(
     benchmarkId: string,
     jobId: string,
@@ -13,6 +16,9 @@ export class Jobs extends APIResource {
     return this._client.get(`/v1/eval/benchmarks/${benchmarkId}/jobs/${jobId}/result`, options);
   }
 
+  /**
+   * Cancel a job.
+   */
   cancel(benchmarkId: string, jobId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v1/eval/benchmarks/${benchmarkId}/jobs/${jobId}`, {
       ...options,
@@ -20,6 +26,9 @@ export class Jobs extends APIResource {
     });
   }
 
+  /**
+   * Get the status of a job.
+   */
   status(
     benchmarkId: string,
     jobId: string,