llama-stack-client 0.1.0 → 0.1.3

package/src/resources/shared.ts

@@ -5,32 +5,79 @@ import * as InferenceAPI from './inference';
 import * as ToolRuntimeAPI from './tool-runtime/tool-runtime';
 
 export interface AgentConfig {
-  enable_session_persistence: boolean;
-
   instructions: string;
 
-  max_infer_iters: number;
-
   model: string;
 
   client_tools?: Array<ToolRuntimeAPI.ToolDef>;
 
+  enable_session_persistence?: boolean;
+
   input_shields?: Array<string>;
 
+  max_infer_iters?: number;
+
   output_shields?: Array<string>;
 
+  /**
+   * Configuration for JSON schema-guided response generation.
+   */
   response_format?: ResponseFormat;
 
   sampling_params?: SamplingParams;
 
+  /**
+   * Whether tool use is required or automatic. This is a hint to the model which may
+   * not be followed. It depends on the Instruction Following capabilities of the
+   * model.
+   */
   tool_choice?: 'auto' | 'required';
 
+  /**
+   * Configuration for tool use.
+   */
+  tool_config?: AgentConfig.ToolConfig;
+
+  /**
+   * Prompt format for calling custom / zero shot tools.
+   */
   tool_prompt_format?: 'json' | 'function_tag' | 'python_list';
 
   toolgroups?: Array<string | AgentConfig.UnionMember1>;
 }
 
 export namespace AgentConfig {
+  /**
+   * Configuration for tool use.
+   */
+  export interface ToolConfig {
+    /**
+     * (Optional) Config for how to override the default system prompt. -
+     * `SystemMessageBehavior.append`: Appends the provided system message to the
+     * default system prompt. - `SystemMessageBehavior.replace`: Replaces the default
+     * system prompt with the provided system message. The system message can include
+     * the string '{{function_definitions}}' to indicate where the function definitions
+     * should be inserted.
+     */
+    system_message_behavior: 'append' | 'replace';
+
+    /**
+     * (Optional) Whether tool use is required or automatic. Defaults to
+     * ToolChoice.auto.
+     */
+    tool_choice?: 'auto' | 'required';
+
+    /**
+     * (Optional) Instructs the model how to format tool calls. By default, Llama Stack
+     * will attempt to use a format that is best adapted to the model. -
+     * `ToolPromptFormat.json`: The tool calls are formatted as a JSON object. -
+     * `ToolPromptFormat.function_tag`: The tool calls are enclosed in a
+     * <function=function_name> tag. - `ToolPromptFormat.python_list`: The tool calls
+     * are output as Python syntax -- a list of function calls.
+     */
+    tool_prompt_format?: 'json' | 'function_tag' | 'python_list';
+  }
+
   export interface UnionMember1 {
     args: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
@@ -42,6 +89,9 @@ export interface BatchCompletion {
   batch: Array<InferenceAPI.CompletionResponse>;
 }
 
+/**
+ * Response from a chat completion request.
+ */
 export interface ChatCompletionResponse {
   /**
    * The complete response message
@@ -52,8 +102,33 @@ export interface ChatCompletionResponse {
    * Optional log probabilities for generated tokens
    */
   logprobs?: Array<InferenceAPI.TokenLogProbs>;
+
+  metrics?: Array<ChatCompletionResponse.Metric>;
+}
+
+export namespace ChatCompletionResponse {
+  export interface Metric {
+    metric: string;
+
+    span_id: string;
+
+    timestamp: string;
+
+    trace_id: string;
+
+    type: 'metric';
+
+    unit: string;
+
+    value: number;
+
+    attributes?: Record<string, string | number | boolean | null>;
+  }
 }
 
+/**
+ * A message containing the model's (assistant) response in a chat conversation.
+ */
 export interface CompletionMessage {
   /**
    * The content of the model's response
@@ -78,7 +153,7 @@ export interface CompletionMessage {
   /**
    * List of tool calls. Each tool call is a ToolCall object.
    */
-  tool_calls: Array<ToolCall>;
+  tool_calls?: Array<ToolCall>;
 }
 
 export type ContentDelta = ContentDelta.TextDelta | ContentDelta.ImageDelta | ContentDelta.ToolCallDelta;
@@ -99,19 +174,22 @@ export namespace ContentDelta {
   export interface ToolCallDelta {
     parse_status: 'started' | 'in_progress' | 'failed' | 'succeeded';
 
-    tool_call: string | Shared.ToolCall;
+    tool_call: Shared.ToolCallOrString;
 
     type: 'tool_call';
   }
 }
 
 export interface Document {
+  /**
+   * A image content item
+   */
   content:
     | string
     | Document.ImageContentItem
     | Document.TextContentItem
     | Array<InterleavedContentItem>
-    | URL;
+    | Document.URL;
 
   document_id: string;
 
@@ -121,6 +199,9 @@ export interface Document {
 }
 
 export namespace Document {
+  /**
+   * A image content item
+   */
   export interface ImageContentItem {
     /**
      * Image as a base64 encoded string or an URL
@@ -147,10 +228,23 @@ export namespace Document {
        * A URL of the image or data URL in the format of data:image/{type};base64,{data}.
        * Note that URL could have length limits.
        */
-      url?: Shared.URL;
+      url?: Image.URL;
+    }
+
+    export namespace Image {
+      /**
+       * A URL of the image or data URL in the format of data:image/{type};base64,{data}.
+       * Note that URL could have length limits.
+       */
+      export interface URL {
+        uri: string;
+      }
     }
   }
 
+  /**
+   * A text content item
+   */
   export interface TextContentItem {
     /**
      * Text content
@@ -162,8 +256,15 @@ export namespace Document {
      */
     type: 'text';
   }
+
+  export interface URL {
+    uri: string;
+  }
 }
 
+/**
+ * A image content item
+ */
 export type InterleavedContent =
   | string
   | InterleavedContent.ImageContentItem
@@ -171,6 +272,9 @@ export type InterleavedContent =
   | Array<InterleavedContentItem>;
 
 export namespace InterleavedContent {
+  /**
+   * A image content item
+   */
   export interface ImageContentItem {
     /**
      * Image as a base64 encoded string or an URL
@@ -197,10 +301,23 @@ export namespace InterleavedContent {
        * A URL of the image or data URL in the format of data:image/{type};base64,{data}.
        * Note that URL could have length limits.
        */
-      url?: Shared.URL;
+      url?: Image.URL;
+    }
+
+    export namespace Image {
+      /**
+       * A URL of the image or data URL in the format of data:image/{type};base64,{data}.
+       * Note that URL could have length limits.
+       */
+      export interface URL {
+        uri: string;
+      }
     }
   }
 
+  /**
+   * A text content item
+   */
   export interface TextContentItem {
     /**
      * Text content
@@ -214,11 +331,17 @@ export namespace InterleavedContent {
   }
 }
 
+/**
+ * A image content item
+ */
 export type InterleavedContentItem =
   | InterleavedContentItem.ImageContentItem
   | InterleavedContentItem.TextContentItem;
 
 export namespace InterleavedContentItem {
+  /**
+   * A image content item
+   */
   export interface ImageContentItem {
     /**
      * Image as a base64 encoded string or an URL
@@ -245,10 +368,23 @@ export namespace InterleavedContentItem {
        * A URL of the image or data URL in the format of data:image/{type};base64,{data}.
        * Note that URL could have length limits.
        */
-      url?: Shared.URL;
+      url?: Image.URL;
+    }
+
+    export namespace Image {
+      /**
+       * A URL of the image or data URL in the format of data:image/{type};base64,{data}.
+       * Note that URL could have length limits.
+       */
+      export interface URL {
+        uri: string;
+      }
     }
   }
 
+  /**
+   * A text content item
+   */
   export interface TextContentItem {
     /**
      * Text content
@@ -262,6 +398,9 @@ export namespace InterleavedContentItem {
   }
 }
 
+/**
+ * A message from the user in a chat conversation.
+ */
 export type Message = UserMessage | SystemMessage | ToolResponseMessage | CompletionMessage;
 
 export type ParamType =
@@ -347,12 +486,21 @@ export namespace QueryGeneratorConfig {
 }
 
 export interface QueryResult {
+  /**
+   * A image content item
+   */
   content?: InterleavedContent;
 }
 
+/**
+ * Configuration for JSON schema-guided response generation.
+ */
 export type ResponseFormat = ResponseFormat.JsonSchemaResponseFormat | ResponseFormat.GrammarResponseFormat;
 
 export namespace ResponseFormat {
+  /**
+   * Configuration for JSON schema-guided response generation.
+   */
   export interface JsonSchemaResponseFormat {
     /**
      * The JSON schema the response should conform to. In a Python SDK, this is often a
@@ -366,6 +514,9 @@ export namespace ResponseFormat {
     type: 'json_schema';
   }
 
+  /**
+   * Configuration for grammar-guided response generation.
+   */
   export interface GrammarResponseFormat {
     /**
      * The BNF grammar specification the response should conform to
@@ -438,6 +589,9 @@ export interface ScoringResult {
   score_rows: Array<Record<string, boolean | number | string | Array<unknown> | unknown | null>>;
 }
 
+/**
+ * A system message providing instructions or context to the model.
+ */
 export interface SystemMessage {
   /**
    * The content of the "system prompt". If multiple system messages are provided,
@@ -468,6 +622,8 @@ export interface ToolCall {
   tool_name: 'brave_search' | 'wolfram_alpha' | 'photogen' | 'code_interpreter' | (string & {});
 }
 
+export type ToolCallOrString = string | ToolCall;
+
 export interface ToolParamDefinition {
   param_type: string;
 
@@ -478,6 +634,9 @@ export interface ToolParamDefinition {
   required?: boolean;
 }
 
+/**
+ * A message representing the result of a tool invocation.
+ */
 export interface ToolResponseMessage {
   /**
    * Unique identifier for the tool call this response is for
@@ -500,10 +659,9 @@ export interface ToolResponseMessage {
   tool_name: 'brave_search' | 'wolfram_alpha' | 'photogen' | 'code_interpreter' | (string & {});
 }
 
-export interface URL {
-  uri: string;
-}
-
+/**
+ * A message from the user in a chat conversation.
+ */
 export interface UserMessage {
   /**
    * The content of the message, which can include text and other media

package/src/resources/shields.ts

@@ -20,9 +20,12 @@ export class Shields extends APIResource {
 }
 
 export interface ListShieldsResponse {
-  data: Array<Shield>;
+  data: ShieldListResponse;
 }
 
+/**
+ * A safety shield resource that can be used to check content
+ */
 export interface Shield {
   identifier: string;
 

package/src/resources/synthetic-data-generation.ts

@@ -13,6 +13,10 @@ export class SyntheticDataGeneration extends APIResource {
   }
 }
 
+/**
+ * Response from the synthetic data generation. Batch of (prompt, response, score)
+ * tuples that pass the threshold.
+ */
 export interface SyntheticDataGenerationResponse {
   synthetic_data: Array<Record<string, boolean | number | string | Array<unknown> | unknown | null>>;
 
@@ -22,6 +26,9 @@ export interface SyntheticDataGenerationResponse {
 export interface SyntheticDataGenerationGenerateParams {
   dialogs: Array<Shared.Message>;
 
+  /**
+   * The type of filtering function.
+   */
   filtering_function: 'none' | 'random' | 'top_k' | 'top_p' | 'top_k_top_p' | 'sigmoid';
 
   model?: string;

package/src/resources/telemetry.ts

@@ -104,7 +104,7 @@ export namespace Event {
 
     type: 'unstructured_log';
 
-    attributes?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+    attributes?: Record<string, string | number | boolean | null>;
   }
 
   export interface MetricEvent {
@@ -122,7 +122,7 @@ export namespace Event {
 
     value: number;
 
-    attributes?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+    attributes?: Record<string, string | number | boolean | null>;
   }
 
   export interface StructuredLogEvent {
@@ -136,7 +136,7 @@ export namespace Event {
 
     type: 'structured_log';
 
-    attributes?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+    attributes?: Record<string, string | number | boolean | null>;
   }
 
   export namespace StructuredLogEvent {
@@ -165,25 +165,7 @@ export interface QueryCondition {
 }
 
 export interface QuerySpansResponse {
-  data: Array<QuerySpansResponse.Data>;
-}
-
-export namespace QuerySpansResponse {
-  export interface Data {
-    name: string;
-
-    span_id: string;
-
-    start_time: string;
-
-    trace_id: string;
-
-    attributes?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
-
-    end_time?: string;
-
-    parent_span_id?: string;
-  }
+  data: TelemetryQuerySpansResponse;
 }
 
 export interface SpanWithStatus {

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

@@ -33,6 +33,9 @@ export interface RagToolInsertParams {
 }
 
 export interface RagToolQueryParams {
+  /**
+   * A image content item
+   */
   content: Shared.InterleavedContent;
 
   vector_db_ids: Array<string>;

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

@@ -69,6 +69,9 @@ export namespace ToolDef {
 }
 
 export interface ToolInvocationResult {
+  /**
+   * A image content item
+   */
   content: Shared.InterleavedContent;
 
   error_code?: number;
@@ -83,11 +86,17 @@ export interface ToolRuntimeInvokeToolParams {
 }
 
 export interface ToolRuntimeListToolsParams {
-  mcp_endpoint?: Shared.URL;
+  mcp_endpoint?: ToolRuntimeListToolsParams.McpEndpoint;
 
   tool_group_id?: string;
 }
 
+export namespace ToolRuntimeListToolsParams {
+  export interface McpEndpoint {
+    uri: string;
+  }
+}
+
 ToolRuntime.RagTool = RagTool;
 
 export declare namespace ToolRuntime {

package/src/resources/toolgroups.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
-import * as Shared from './shared';
 
 export class Toolgroups extends APIResource {
   /**
@@ -41,7 +40,7 @@ export class Toolgroups extends APIResource {
 }
 
 export interface ListToolGroupsResponse {
-  data: Array<ToolGroup>;
+  data: ToolgroupListResponse;
 }
 
 export interface ToolGroup {
@@ -55,7 +54,13 @@ export interface ToolGroup {
 
   args?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
-  mcp_endpoint?: Shared.URL;
+  mcp_endpoint?: ToolGroup.McpEndpoint;
+}
+
+export namespace ToolGroup {
+  export interface McpEndpoint {
+    uri: string;
+  }
 }
 
 export type ToolgroupListResponse = Array<ToolGroup>;
@@ -67,7 +72,13 @@ export interface ToolgroupRegisterParams {
 
   args?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
 
-  mcp_endpoint?: Shared.URL;
+  mcp_endpoint?: ToolgroupRegisterParams.McpEndpoint;
+}
+
+export namespace ToolgroupRegisterParams {
+  export interface McpEndpoint {
+    uri: string;
+  }
 }
 
 export declare namespace Toolgroups {

package/src/resources/tools.ts

@@ -28,7 +28,7 @@ export class Tools extends APIResource {
 }
 
 export interface ListToolsResponse {
-  data: Array<Tool>;
+  data: ToolListResponse;
 }
 
 export interface Tool {

package/src/resources/vector-dbs.ts

@@ -33,23 +33,7 @@ export class VectorDBs extends APIResource {
 }
 
 export interface ListVectorDBsResponse {
-  data: Array<ListVectorDBsResponse.Data>;
-}
-
-export namespace ListVectorDBsResponse {
-  export interface Data {
-    embedding_dimension: number;
-
-    embedding_model: string;
-
-    identifier: string;
-
-    provider_id: string;
-
-    provider_resource_id: string;
-
-    type: 'vector_db';
-  }
+  data: VectorDBListResponse;
 }
 
 export interface VectorDBRetrieveResponse {

package/src/resources/vector-io.ts

@@ -26,6 +26,9 @@ export interface QueryChunksResponse {
 
 export namespace QueryChunksResponse {
   export interface Chunk {
+    /**
+     * A image content item
+     */
     content: Shared.InterleavedContent;
 
     metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
@@ -42,6 +45,9 @@ export interface VectorIoInsertParams {
 
 export namespace VectorIoInsertParams {
   export interface Chunk {
+    /**
+     * A image content item
+     */
     content: Shared.InterleavedContent;
 
     metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
@@ -49,6 +55,9 @@ export namespace VectorIoInsertParams {
 }
 
 export interface VectorIoQueryParams {
+  /**
+   * A image content item
+   */
   query: Shared.InterleavedContent;
 
   vector_db_id: string;

package/src/streaming.ts

@@ -313,13 +313,17 @@ class SSEDecoder {
 }
 
 /** This is an internal helper function that's just used for testing */
-export function _decodeChunks(chunks: string[]): string[] {
+export function _decodeChunks(chunks: string[], { flush }: { flush: boolean } = { flush: false }): string[] {
   const decoder = new LineDecoder();
   const lines: string[] = [];
   for (const chunk of chunks) {
     lines.push(...decoder.decode(chunk));
   }
 
+  if (flush) {
+    lines.push(...decoder.flush());
+  }
+
   return lines;
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0';
+export const VERSION = '0.1.3';

package/streaming.d.ts

@@ -30,5 +30,7 @@ export declare class Stream<Item> implements AsyncIterable<Item> {
 }
 export declare function _iterSSEMessages(response: Response, controller: AbortController): AsyncGenerator<ServerSentEvent, void, unknown>;
 /** This is an internal helper function that's just used for testing */
-export declare function _decodeChunks(chunks: string[]): string[];
+export declare function _decodeChunks(chunks: string[], { flush }?: {
+    flush: boolean;
+}): string[];
 //# sourceMappingURL=streaming.d.ts.map

package/streaming.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAO/D,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF,qBAAa,MAAM,CAAC,IAAI,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;IAIpD,OAAO,CAAC,QAAQ;IAHlB,UAAU,EAAE,eAAe,CAAC;gBAGlB,QAAQ,EAAE,MAAM,aAAa,CAAC,IAAI,CAAC,EAC3C,UAAU,EAAE,eAAe;IAK7B,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IAiC3F;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IA2C1G,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC;IAI7C;;;OAGG;IACH,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAwBnC;;;;OAIG;IACH,gBAAgB,IAAI,cAAc;CA0BnC;AAED,wBAAuB,gBAAgB,CACrC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,eAAe,GAC1B,cAAc,CAAC,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC,CAqBhD;AA0HD,uEAAuE;AACvE,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,CAQxD"}
+{"version":3,"file":"streaming.d.ts","sourceRoot":"","sources":["src/streaming.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAO/D,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,EAAE,CAAC;CACf,CAAC;AAEF,qBAAa,MAAM,CAAC,IAAI,CAAE,YAAW,aAAa,CAAC,IAAI,CAAC;IAIpD,OAAO,CAAC,QAAQ;IAHlB,UAAU,EAAE,eAAe,CAAC;gBAGlB,QAAQ,EAAE,MAAM,aAAa,CAAC,IAAI,CAAC,EAC3C,UAAU,EAAE,eAAe;IAK7B,MAAM,CAAC,eAAe,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IAiC3F;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,cAAc,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC;IA2C1G,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,IAAI,CAAC;IAI7C;;;OAGG;IACH,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAwBnC;;;;OAIG;IACH,gBAAgB,IAAI,cAAc;CA0BnC;AAED,wBAAuB,gBAAgB,CACrC,QAAQ,EAAE,QAAQ,EAClB,UAAU,EAAE,eAAe,GAC1B,cAAc,CAAC,eAAe,EAAE,IAAI,EAAE,OAAO,CAAC,CAqBhD;AA0HD,uEAAuE;AACvE,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAE;IAAE,KAAK,EAAE,OAAO,CAAA;CAAqB,GAAG,MAAM,EAAE,CAY1G"}

package/streaming.js

@@ -269,12 +269,15 @@ class SSEDecoder {
     }
 }
 /** This is an internal helper function that's just used for testing */
-function _decodeChunks(chunks) {
+function _decodeChunks(chunks, { flush } = { flush: false }) {
     const decoder = new line_1.LineDecoder();
     const lines = [];
     for (const chunk of chunks) {
         lines.push(...decoder.decode(chunk));
     }
+    if (flush) {
+        lines.push(...decoder.flush());
+    }
     return lines;
 }
 exports._decodeChunks = _decodeChunks;