llama-stack-client 0.4.4 → 0.4.5

package/src/resources/embeddings.ts

@@ -11,8 +11,6 @@ import * as Core from '../core';
 
 export class Embeddings extends APIResource {
   /**
-   * Create embeddings.
-   *
    * Generate OpenAI-compatible embeddings for the given input using the specified
    * model.
    */
@@ -28,15 +26,24 @@ export class Embeddings extends APIResource {
  * Response from an OpenAI-compatible embeddings request.
  */
 export interface CreateEmbeddingsResponse {
+  /**
+   * List of embedding data objects.
+   */
   data: Array<CreateEmbeddingsResponse.Data>;
 
+  /**
+   * The model that was used to generate the embeddings.
+   */
   model: string;
 
   /**
-   * Usage information for an OpenAI-compatible embeddings response.
+   * Usage information.
    */
   usage: CreateEmbeddingsResponse.Usage;
 
+  /**
+   * The object type.
+   */
   object?: 'list';
 }
 
@@ -45,33 +52,64 @@ export namespace CreateEmbeddingsResponse {
    * A single embedding data object from an OpenAI-compatible embeddings response.
    */
   export interface Data {
+    /**
+     * The embedding vector as a list of floats (when encoding_format='float') or as a
+     * base64-encoded string.
+     */
     embedding: Array<number> | string;
 
+    /**
+     * The index of the embedding in the input list.
+     */
     index: number;
 
+    /**
+     * The object type.
+     */
     object?: 'embedding';
   }
 
   /**
-   * Usage information for an OpenAI-compatible embeddings response.
+   * Usage information.
    */
   export interface Usage {
+    /**
+     * The number of tokens in the input.
+     */
     prompt_tokens: number;
 
+    /**
+     * The total number of tokens used.
+     */
     total_tokens: number;
   }
 }
 
 export interface EmbeddingCreateParams {
-  input: string | Array<string>;
+  /**
+   * Input text to embed, encoded as a string or array of tokens.
+   */
+  input: string | Array<string> | Array<number> | Array<Array<number>>;
 
+  /**
+   * The identifier of the model to use.
+   */
   model: string;
 
-  dimensions?: number | null;
+  /**
+   * The number of dimensions for output embeddings.
+   */
+  dimensions?: number;
 
-  encoding_format?: string | null;
+  /**
+   * The format to return the embeddings in.
+   */
+  encoding_format?: 'float' | 'base64';
 
-  user?: string | null;
+  /**
+   * A unique identifier representing your end-user.
+   */
+  user?: string;
 
   [k: string]: unknown;
 }

package/src/resources/files.ts

@@ -13,33 +13,21 @@ import { OpenAICursorPage, type OpenAICursorPageParams } from '../pagination';
 
 export class Files extends APIResource {
   /**
-   * Upload file.
-   *
-   * Upload a file that can be used across various endpoints.
-   *
-   * The file upload should be a multipart form request with:
-   *
-   * - file: The File object (not file name) to be uploaded.
-   * - purpose: The intended purpose of the uploaded file.
-   * - expires_after: Optional form values describing expiration for the file.
+   * Upload a file.
    */
   create(body: FileCreateParams, options?: Core.RequestOptions): Core.APIPromise<File> {
     return this._client.post('/v1/files', Core.multipartFormRequestOptions({ body, ...options }));
   }
 
   /**
-   * Retrieve file.
-   *
-   * Returns information about a specific file.
+   * Get file
    */
   retrieve(fileId: string, options?: Core.RequestOptions): Core.APIPromise<File> {
     return this._client.get(`/v1/files/${fileId}`, options);
   }
 
   /**
-   * List files.
-   *
-   * Returns a list of files that belong to the user's organization.
+   * List files
    */
   list(query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<FilesOpenAICursorPage, File>;
   list(options?: Core.RequestOptions): Core.PagePromise<FilesOpenAICursorPage, File>;
@@ -54,16 +42,14 @@ export class Files extends APIResource {
   }
 
   /**
-   * Delete file.
+   * Delete file
    */
   delete(fileId: string, options?: Core.RequestOptions): Core.APIPromise<DeleteFileResponse> {
     return this._client.delete(`/v1/files/${fileId}`, options);
   }
 
   /**
-   * Retrieve file content.
-   *
-   * Returns the contents of the specified file.
+   * Retrieve file content
    */
   content(fileId: string, options?: Core.RequestOptions): Core.APIPromise<unknown> {
     return this._client.get(`/v1/files/${fileId}/content`, options);
@@ -76,10 +62,19 @@ export class FilesOpenAICursorPage extends OpenAICursorPage<File> {}
  * Response for deleting a file in OpenAI Files API.
  */
 export interface DeleteFileResponse {
+  /**
+   * The file identifier that was deleted.
+   */
   id: string;
 
+  /**
+   * Whether the file was successfully deleted.
+   */
   deleted: boolean;
 
+  /**
+   * The object type, which is always 'file'.
+   */
   object?: 'file';
 }
 
@@ -87,21 +82,39 @@ export interface DeleteFileResponse {
  * OpenAI File object as defined in the OpenAI Files API.
  */
 export interface File {
+  /**
+   * The file identifier, which can be referenced in the API endpoints.
+   */
   id: string;
 
+  /**
+   * The size of the file, in bytes.
+   */
   bytes: number;
 
+  /**
+   * The Unix timestamp (in seconds) for when the file was created.
+   */
   created_at: number;
 
+  /**
+   * The Unix timestamp (in seconds) for when the file expires.
+   */
   expires_at: number;
 
+  /**
+   * The name of the file.
+   */
   filename: string;
 
   /**
-   * Valid purpose values for OpenAI Files API.
+   * The intended purpose of the file.
    */
   purpose: 'assistants' | 'batch';
 
+  /**
+   * The object type, which is always 'file'.
+   */
   object?: 'file';
 }
 
@@ -109,34 +122,47 @@ export interface File {
  * Response for listing files in OpenAI Files API.
  */
 export interface ListFilesResponse {
+  /**
+   * The list of files.
+   */
   data: Array<File>;
 
+  /**
+   * The ID of the first file in the list for pagination.
+   */
   first_id: string;
 
+  /**
+   * Whether there are more files available beyond this page.
+   */
   has_more: boolean;
 
+  /**
+   * The ID of the last file in the list for pagination.
+   */
   last_id: string;
 
+  /**
+   * The object type, which is always 'list'.
+   */
   object?: 'list';
 }
 
 export type FileContentResponse = unknown;
 
 export interface FileCreateParams {
+  /**
+   * The file to upload.
+   */
   file: Core.Uploadable;
 
   /**
-   * Valid purpose values for OpenAI Files API.
+   * The intended purpose of the uploaded file.
    */
   purpose: 'assistants' | 'batch';
 
   /**
    * Control expiration of uploaded files.
-   *
-   * Params:
-   *
-   * - anchor, must be "created_at"
-   * - seconds, must be int between 3600 and 2592000 (1 hour to 30 days)
    */
   expires_after?: FileCreateParams.ExpiresAfter | null;
 }
@@ -144,15 +170,16 @@ export interface FileCreateParams {
 export namespace FileCreateParams {
   /**
    * Control expiration of uploaded files.
-   *
-   * Params:
-   *
-   * - anchor, must be "created_at"
-   * - seconds, must be int between 3600 and 2592000 (1 hour to 30 days)
    */
   export interface ExpiresAfter {
+    /**
+     * The anchor point for expiration, must be 'created_at'.
+     */
     anchor: 'created_at';
 
+    /**
+     * Seconds until expiration, between 3600 (1 hour) and 2592000 (30 days).
+     */
     seconds: number;
   }
 }

package/src/resources/index.ts

@@ -45,7 +45,7 @@ export {
   type FileCreateParams,
   type FileListParams,
 } from './files';
-export { Inspect, type HealthInfo, type ProviderInfo, type RouteInfo, type VersionInfo } from './inspect';
+export { Inspect } from './inspect';
 export {
   Models,
   type ListModelsResponse,
@@ -66,7 +66,7 @@ export {
   type PromptUpdateParams,
   type PromptSetDefaultVersionParams,
 } from './prompts/prompts';
-export { Providers, type ListProvidersResponse, type ProviderListResponse } from './providers';
+export { Providers, type ProviderListResponse } from './providers';
 export {
   ResponseListResponsesOpenAICursorPage,
   Responses,
@@ -79,7 +79,7 @@ export {
   type ResponseCreateParamsStreaming,
   type ResponseListParams,
 } from './responses/responses';
-export { Routes, type ListRoutesResponse, type RouteListResponse, type RouteListParams } from './routes';
+export { Routes, type RouteListResponse, type RouteListParams } from './routes';
 export { Safety, type RunShieldResponse, type SafetyRunShieldParams } from './safety';
 export {
   Scoring,

package/src/resources/inspect.ts

@@ -8,74 +8,20 @@
 
 import { APIResource } from '../resource';
 import * as Core from '../core';
+import * as Shared from './shared';
 
 export class Inspect extends APIResource {
   /**
-   * Get health status.
-   *
    * Get the current health status of the service.
    */
-  health(options?: Core.RequestOptions): Core.APIPromise<HealthInfo> {
+  health(options?: Core.RequestOptions): Core.APIPromise<Shared.HealthInfo> {
     return this._client.get('/v1/health', options);
   }
 
   /**
-   * Get version.
-   *
    * Get the version of the service.
    */
-  version(options?: Core.RequestOptions): Core.APIPromise<VersionInfo> {
+  version(options?: Core.RequestOptions): Core.APIPromise<Shared.VersionInfo> {
     return this._client.get('/v1/version', options);
   }
 }
-
-/**
- * Health status information for the service.
- */
-export interface HealthInfo {
-  status: 'OK' | 'Error' | 'Not Implemented';
-}
-
-/**
- * Information about a registered provider including its configuration and health
- * status.
- */
-export interface ProviderInfo {
-  api: string;
-
-  config: { [key: string]: unknown };
-
-  health: { [key: string]: unknown };
-
-  provider_id: string;
-
-  provider_type: string;
-}
-
-/**
- * Information about an API route including its path, method, and implementing
- * providers.
- */
-export interface RouteInfo {
-  method: string;
-
-  provider_types: Array<string>;
-
-  route: string;
-}
-
-/**
- * Version information for the service.
- */
-export interface VersionInfo {
-  version: string;
-}
-
-export declare namespace Inspect {
-  export {
-    type HealthInfo as HealthInfo,
-    type ProviderInfo as ProviderInfo,
-    type RouteInfo as RouteInfo,
-    type VersionInfo as VersionInfo,
-  };
-}

package/src/resources/models/models.ts

@@ -15,8 +15,6 @@ export class Models extends APIResource {
   openai: OpenAIAPI.OpenAI = new OpenAIAPI.OpenAI(this._client);
 
   /**
-   * Get model.
-   *
    * Get a model by its identifier.
    */
   retrieve(modelId: string, options?: Core.RequestOptions): Core.APIPromise<ModelRetrieveResponse> {
@@ -33,8 +31,6 @@ export class Models extends APIResource {
   }
 
   /**
-   * Register model.
-   *
    * Register a model.
    *
    * @deprecated
@@ -44,8 +40,6 @@ export class Models extends APIResource {
   }
 
   /**
-   * Unregister model.
-   *
    * Unregister a model.
    *
    * @deprecated
@@ -58,7 +52,13 @@ export class Models extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of OpenAI model objects.
+ */
 export interface ListModelsResponse {
+  /**
+   * List of OpenAI model objects.
+   */
   data: ModelListResponse;
 }
 
@@ -114,6 +114,9 @@ export interface ModelRetrieveResponse {
   type?: 'model';
 }
 
+/**
+ * List of OpenAI model objects.
+ */
 export type ModelListResponse = Array<Model>;
 
 /**
@@ -149,8 +152,14 @@ export interface ModelRegisterResponse {
 }
 
 export interface ModelRegisterParams {
+  /**
+   * The identifier of the model to register.
+   */
   model_id: string;
 
+  /**
+   * Any additional metadata for this model.
+   */
   metadata?: { [key: string]: unknown } | null;
 
   /**
@@ -158,8 +167,14 @@ export interface ModelRegisterParams {
    */
   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;
 }
 

package/src/resources/moderations.ts

@@ -11,9 +11,7 @@ import * as Core from '../core';
 
 export class Moderations extends APIResource {
   /**
-   * Create moderation.
-   *
-   * Classifies if text and/or image inputs are potentially harmful.
+   * Classifies if text inputs are potentially harmful. OpenAI-compatible endpoint.
    */
   create(body: ModerationCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateResponse> {
     return this._client.post('/v1/moderations', { body, ...options });
@@ -21,38 +19,73 @@ export class Moderations extends APIResource {
 }
 
 /**
- * A moderation object.
+ * A moderation object containing the results of content classification.
  */
 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 result objects
+   */
   results: Array<CreateResponse.Result>;
 }
 
 export namespace CreateResponse {
   /**
-   * A moderation object.
+   * A moderation result object containing flagged status and category information.
    */
   export interface Result {
+    /**
+     * Whether any of the below categories are flagged
+     */
     flagged: boolean;
 
+    /**
+     * A dictionary of the categories, and whether they are flagged or not
+     */
     categories?: { [key: string]: boolean } | null;
 
+    /**
+     * A dictionary of the categories along with the input type(s) that the score
+     * applies to
+     */
     category_applied_input_types?: { [key: string]: Array<string> } | null;
 
+    /**
+     * A dictionary of the categories along with their scores as predicted by model
+     */
     category_scores?: { [key: string]: number } | null;
 
+    /**
+     * Additional metadata about the moderation
+     */
     metadata?: { [key: string]: unknown };
 
+    /**
+     * A message to convey to the user about the moderation result
+     */
     user_message?: string | null;
   }
 }
 
 export interface ModerationCreateParams {
+  /**
+   * Input (or inputs) to classify. Can be a single string or an array of strings.
+   */
   input: string | Array<string>;
 
+  /**
+   * The content moderation model to use. If not specified, the default shield will
+   * be used.
+   */
   model?: string | null;
 }
 

package/src/resources/prompts/prompts.ts

@@ -16,8 +16,6 @@ export class Prompts extends APIResource {
   versions: VersionsAPI.Versions = new VersionsAPI.Versions(this._client);
 
   /**
-   * Create prompt.
-   *
    * Create a new prompt.
    */
   create(body: PromptCreateParams, options?: Core.RequestOptions): Core.APIPromise<Prompt> {
@@ -25,8 +23,6 @@ export class Prompts extends APIResource {
   }
 
   /**
-   * Get prompt.
-   *
    * Get a prompt by its identifier and optional version.
    */
   retrieve(
@@ -47,12 +43,10 @@ export class Prompts extends APIResource {
   }
 
   /**
-   * Update prompt.
-   *
    * Update an existing prompt (increments version).
    */
   update(promptId: string, body: PromptUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Prompt> {
-    return this._client.post(`/v1/prompts/${promptId}`, { body, ...options });
+    return this._client.put(`/v1/prompts/${promptId}`, { body, ...options });
   }
 
   /**
@@ -65,8 +59,6 @@ export class Prompts extends APIResource {
   }
 
   /**
-   * Delete prompt.
-   *
    * Delete a prompt.
    */
   delete(promptId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
@@ -77,8 +69,6 @@ export class Prompts extends APIResource {
   }
 
   /**
-   * Set prompt version.
-   *
    * Set which version of a prompt should be the default in get_prompt (latest).
    */
   setDefaultVersion(
@@ -86,7 +76,7 @@ export class Prompts extends APIResource {
     body: PromptSetDefaultVersionParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<Prompt> {
-    return this._client.post(`/v1/prompts/${promptId}/set-default-version`, { body, ...options });
+    return this._client.put(`/v1/prompts/${promptId}/set-default-version`, { body, ...options });
   }
 }
 
@@ -131,26 +121,50 @@ export interface Prompt {
 export type PromptListResponse = Array<Prompt>;
 
 export interface PromptCreateParams {
+  /**
+   * The prompt text content with variable placeholders.
+   */
   prompt: string;
 
+  /**
+   * List of variable names that can be used in the prompt template.
+   */
   variables?: Array<string> | null;
 }
 
 export interface PromptRetrieveParams {
+  /**
+   * The version of the prompt to get (defaults to latest).
+   */
   version?: number | null;
 }
 
 export interface PromptUpdateParams {
+  /**
+   * The updated prompt text content.
+   */
   prompt: string;
 
+  /**
+   * The current version of the prompt being updated.
+   */
   version: number;
 
+  /**
+   * Set the new version as the default (default=True).
+   */
   set_as_default?: boolean;
 
+  /**
+   * Updated list of variable names that can be used in the prompt template.
+   */
   variables?: Array<string> | null;
 }
 
 export interface PromptSetDefaultVersionParams {
+  /**
+   * The version to set as default.
+   */
   version: number;
 }
 

package/src/resources/prompts/versions.ts

@@ -12,8 +12,6 @@ import * as PromptsAPI from './prompts';
 
 export class Versions extends APIResource {
   /**
-   * List prompt versions.
-   *
    * List all versions of a specific prompt.
    */
   list(promptId: string, options?: Core.RequestOptions): Core.APIPromise<PromptsAPI.PromptListResponse> {