llama-stack-client 0.6.1 → 0.7.1

package/src/resources/files.ts

@@ -11,6 +11,9 @@ import { isRequestOptions } from '../core';
 import * as Core from '../core';
 import { OpenAICursorPage, type OpenAICursorPageParams } from '../pagination';
 
+/**
+ * This API is used to upload documents that can be used with other Llama Stack APIs.
+ */
 export class Files extends APIResource {
   /**
    * Upload a file.
@@ -51,7 +54,7 @@ export class Files extends APIResource {
   /**
    * Retrieve file content
    */
-  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
+  content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<string> {
     return this._client.get(`/v1/files/${fileId}/content`, options);
   }
 }
@@ -97,11 +100,6 @@ export interface File {
    */
   created_at: number;
 
-  /**
-   * The Unix timestamp (in seconds) for when the file expires.
-   */
-  expires_at: number;
-
   /**
    * The name of the file.
    */
@@ -112,6 +110,11 @@ export interface File {
    */
   purpose: 'assistants' | 'batch';
 
+  /**
+   * The Unix timestamp (in seconds) for when the file expires.
+   */
+  expires_at?: number | null;
+
   /**
    * The object type, which is always 'file'.
    */
@@ -148,7 +151,7 @@ export interface ListFilesResponse {
   object?: 'list';
 }
 
-export type FileContentResponse = unknown;
+export type FileContentResponse = string;
 
 export interface FileCreateParams {
   /**
@@ -186,12 +189,12 @@ export namespace FileCreateParams {
 
 export interface FileListParams extends OpenAICursorPageParams {
   /**
-   * Sort order for paginated responses.
+   * Sort order by created_at timestamp ('asc' or 'desc').
    */
   order?: 'asc' | 'desc' | null;
 
   /**
-   * Valid purpose values for OpenAI Files API.
+   * Filter files by purpose.
    */
   purpose?: 'assistants' | 'batch' | null;
 }

package/src/resources/index.ts

@@ -52,8 +52,6 @@ export {
   type Model,
   type ModelRetrieveResponse,
   type ModelListResponse,
-  type ModelRegisterResponse,
-  type ModelRegisterParams,
 } from './models/models';
 export { Moderations, type CreateResponse, type ModerationCreateParams } from './moderations';
 export {
@@ -103,22 +101,6 @@ export {
   type ShieldListResponse,
   type ShieldRegisterParams,
 } from './shields';
-export {
-  ToolRuntime,
-  type ToolDef,
-  type ToolInvocationResult,
-  type ToolRuntimeListToolsResponse,
-  type ToolRuntimeInvokeToolParams,
-  type ToolRuntimeListToolsParams,
-} from './tool-runtime';
-export {
-  Toolgroups,
-  type ListToolGroupsResponse,
-  type ToolGroup,
-  type ToolgroupListResponse,
-  type ToolgroupRegisterParams,
-} from './toolgroups';
-export { Tools, type ToolListResponse, type ToolListParams } from './tools';
 export {
   VectorIo,
   type QueryChunksResponse,

package/src/resources/inspect.ts

@@ -10,6 +10,9 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 import * as Shared from './shared';
 
+/**
+ * APIs for inspecting the Llama Stack service, including health status, available API routes with methods and implementing providers.
+ */
 export class Inspect extends APIResource {
   /**
    * Get the current health status of the service.

package/src/resources/models/index.ts

@@ -12,7 +12,5 @@ export {
   type Model,
   type ModelRetrieveResponse,
   type ModelListResponse,
-  type ModelRegisterResponse,
-  type ModelRegisterParams,
 } from './models';
 export { OpenAI } from './openai';

package/src/resources/models/models.ts

@@ -29,27 +29,6 @@ export class Models extends APIResource {
       this._client.get('/v1/models', options) as Core.APIPromise<{ data: ModelListResponse }>
     )._thenUnwrap((obj) => obj.data);
   }
-
-  /**
-   * Register a model.
-   *
-   * @deprecated
-   */
-  register(body: ModelRegisterParams, options?: Core.RequestOptions): Core.APIPromise<ModelRegisterResponse> {
-    return this._client.post('/v1/models', { body, ...options });
-  }
-
-  /**
-   * Unregister a model.
-   *
-   * @deprecated
-   */
-  unregister(modelId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/v1/models/${modelId}`, {
-      ...options,
-      headers: { Accept: '*/*', ...options?.headers },
-    });
-  }
 }
 
 /**
@@ -106,6 +85,13 @@ export interface ModelRetrieveResponse {
    */
   model_type?: 'llm' | 'embedding' | 'rerank';
 
+  /**
+   * Enable model availability check during registration. When false (default),
+   * validation is deferred to runtime and model is preserved during provider
+   * refresh.
+   */
+  model_validation?: boolean | null;
+
   /**
    * Unique identifier for this resource in the provider
    */
@@ -119,65 +105,6 @@ export interface ModelRetrieveResponse {
  */
 export type ModelListResponse = Array<Model>;
 
-/**
- * A model resource representing an AI model registered in Llama Stack.
- */
-export interface ModelRegisterResponse {
-  /**
-   * Unique identifier for this resource in llama stack
-   */
-  identifier: string;
-
-  /**
-   * ID of the provider that owns this resource
-   */
-  provider_id: string;
-
-  /**
-   * Any additional metadata for this model
-   */
-  metadata?: { [key: string]: unknown };
-
-  /**
-   * Enumeration of supported model types in Llama Stack.
-   */
-  model_type?: 'llm' | 'embedding' | 'rerank';
-
-  /**
-   * Unique identifier for this resource in the provider
-   */
-  provider_resource_id?: string | null;
-
-  type?: 'model';
-}
-
-export interface ModelRegisterParams {
-  /**
-   * The identifier of the model to register.
-   */
-  model_id: string;
-
-  /**
-   * Any additional metadata for this model.
-   */
-  metadata?: { [key: string]: unknown } | null;
-
-  /**
-   * Enumeration of supported model types in Llama Stack.
-   */
-  model_type?: 'llm' | 'embedding' | 'rerank' | null;
-
-  /**
-   * The identifier of the provider.
-   */
-  provider_id?: string | null;
-
-  /**
-   * The identifier of the model in the provider.
-   */
-  provider_model_id?: string | null;
-}
-
 Models.OpenAI = OpenAI;
 
 export declare namespace Models {
@@ -186,8 +113,6 @@ export declare namespace Models {
     type Model as Model,
     type ModelRetrieveResponse as ModelRetrieveResponse,
     type ModelListResponse as ModelListResponse,
-    type ModelRegisterResponse as ModelRegisterResponse,
-    type ModelRegisterParams as ModelRegisterParams,
   };
 
   export { OpenAI as OpenAI };

package/src/resources/moderations.ts

@@ -9,6 +9,9 @@
 import { APIResource } from '../resource';
 import * as Core from '../core';
 
+/**
+ * OpenAI-compatible Moderations API.
+ */
 export class Moderations extends APIResource {
   /**
    * Classifies if text inputs are potentially harmful. OpenAI-compatible endpoint.

package/src/resources/prompts/prompts.ts

@@ -12,6 +12,9 @@ import * as Core from '../../core';
 import * as VersionsAPI from './versions';
 import { Versions } from './versions';
 
+/**
+ * Protocol for prompt management operations.
+ */
 export class Prompts extends APIResource {
   versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
 

package/src/resources/prompts/versions.ts

@@ -10,6 +10,9 @@ import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as PromptsAPI from './prompts';
 
+/**
+ * Protocol for prompt management operations.
+ */
 export class Versions extends APIResource {
   /**
    * List all versions of a specific prompt.

package/src/resources/providers.ts

@@ -10,6 +10,9 @@ import { APIResource } from '../resource';
 import * as Core from '../core';
 import * as Shared from './shared';
 
+/**
+ * Providers API for inspecting, listing, and modifying providers and their configurations.
+ */
 export class Providers extends APIResource {
   /**
    * Get detailed information about a specific provider.

package/src/resources/responses/input-items.ts

@@ -44,6 +44,7 @@ export interface InputItemListResponse {
     | InputItemListResponse.OpenAIResponseOutputMessageMcpCall
     | InputItemListResponse.OpenAIResponseOutputMessageMcpListTools
     | InputItemListResponse.OpenAIResponseMcpApprovalRequest
+    | InputItemListResponse.OpenAIResponseOutputMessageReasoningItem
     | InputItemListResponse.OpenAIResponseInputFunctionToolCallOutput
     | InputItemListResponse.OpenAIResponseMcpApprovalResponse
     | InputItemListResponse.OpenAIResponseMessageOutput
@@ -118,6 +119,9 @@ export namespace InputItemListResponse {
       type?: 'input_file';
     }
 
+    /**
+     * Text content within an output message of an OpenAI response.
+     */
     export interface OpenAIResponseOutputMessageContentOutputTextOutput {
       text: string;
 
@@ -162,6 +166,9 @@ export namespace InputItemListResponse {
         type?: 'url_citation';
       }
 
+      /**
+       * Container file citation annotation referencing a file within a container.
+       */
       export interface OpenAIResponseAnnotationContainerFileCitation {
         container_id: string;
 
@@ -176,6 +183,9 @@ export namespace InputItemListResponse {
         type?: 'container_file_citation';
       }
 
+      /**
+       * File path annotation referencing a generated file in response content.
+       */
       export interface OpenAIResponseAnnotationFilePath {
         file_id: string;
 
@@ -364,6 +374,68 @@ export namespace InputItemListResponse {
     type?: 'mcp_approval_request';
   }
 
+  /**
+   * Reasoning output from the model, representing the model's thinking process.
+   */
+  export interface OpenAIResponseOutputMessageReasoningItem {
+    /**
+     * Unique identifier for the reasoning output item.
+     */
+    id: string;
+
+    /**
+     * Summary of the reasoning output.
+     */
+    summary: Array<OpenAIResponseOutputMessageReasoningItem.Summary>;
+
+    /**
+     * The reasoning content from the model.
+     */
+    content?: Array<OpenAIResponseOutputMessageReasoningItem.Content> | null;
+
+    /**
+     * The status of the reasoning output.
+     */
+    status?: 'in_progress' | 'completed' | 'incomplete' | null;
+
+    /**
+     * The type identifier, always 'reasoning'.
+     */
+    type?: 'reasoning';
+  }
+
+  export namespace OpenAIResponseOutputMessageReasoningItem {
+    /**
+     * A summary of reasoning output from the model.
+     */
+    export interface Summary {
+      /**
+       * The summary text of the reasoning output.
+       */
+      text: string;
+
+      /**
+       * The type identifier, always 'summary_text'.
+       */
+      type?: 'summary_text';
+    }
+
+    /**
+     * Reasoning text from the model.
+     */
+    export interface Content {
+      /**
+       * The reasoning text content from the model.
+       */
+      text: string;
+
+      /**
+       * The type identifier, always 'reasoning_text'.
+       */
+      type?: 'reasoning_text';
+    }
+  }
+
   /**
    * This represents the output of a function call that gets passed back to the
    * model.
@@ -371,7 +443,13 @@ export namespace InputItemListResponse {
   export interface OpenAIResponseInputFunctionToolCallOutput {
     call_id: string;
 
-    output: string;
+    output:
+      | string
+      | Array<
+          | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentText
+          | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentImage
+          | OpenAIResponseInputFunctionToolCallOutput.OpenAIResponseInputMessageContentFile
+        >;
 
     id?: string | null;
 
@@ -380,6 +458,45 @@ export namespace InputItemListResponse {
     type?: 'function_call_output';
   }
 
+  export namespace OpenAIResponseInputFunctionToolCallOutput {
+    /**
+     * Text content for input messages in OpenAI response format.
+     */
+    export interface OpenAIResponseInputMessageContentText {
+      text: string;
+
+      type?: 'input_text';
+    }
+
+    /**
+     * Image content for input messages in OpenAI response format.
+     */
+    export interface OpenAIResponseInputMessageContentImage {
+      detail?: 'low' | 'high' | 'auto';
+
+      file_id?: string | null;
+
+      image_url?: string | null;
+
+      type?: 'input_image';
+    }
+
+    /**
+     * File content for input messages in OpenAI response format.
+     */
+    export interface OpenAIResponseInputMessageContentFile {
+      file_data?: string | null;
+
+      file_id?: string | null;
+
+      file_url?: string | null;
+
+      filename?: string | null;
+
+      type?: 'input_file';
+    }
+  }
+
   /**
    * A response to an MCP approval request.
    */
@@ -460,6 +577,9 @@ export namespace InputItemListResponse {
       type?: 'input_file';
     }
 
+    /**
+     * Text content within an output message of an OpenAI response.
+     */
     export interface OpenAIResponseOutputMessageContentOutputTextOutput {
       text: string;
 
@@ -504,6 +624,9 @@ export namespace InputItemListResponse {
         type?: 'url_citation';
       }
 
+      /**
+       * Container file citation annotation referencing a file within a container.
+       */
       export interface OpenAIResponseAnnotationContainerFileCitation {
         container_id: string;
 
@@ -518,6 +641,9 @@ export namespace InputItemListResponse {
         type?: 'container_file_citation';
       }
 
+      /**
+       * File path annotation referencing a generated file in response content.
+       */
       export interface OpenAIResponseAnnotationFilePath {
         file_id: string;
 
@@ -618,7 +744,7 @@ export interface InputItemListParams {
   limit?: number | null;
 
   /**
-   * Sort order for paginated responses.
+   * The order to return the input items in.
    */
   order?: 'asc' | 'desc' | null;
 }