llama-stack-client 0.3.4 → 0.4.0-rc1

package/src/resources/models/models.ts

@@ -3,26 +3,28 @@
 //
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
-
+//
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
 import * as OpenAIAPI from './openai';
-import { OpenAI, OpenAIListResponse } from './openai';
+import { OpenAI } from './openai';
 
 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<Model> {
+  retrieve(modelId: string, options?: Core.RequestOptions): Core.APIPromise<ModelRetrieveResponse> {
     return this._client.get(`/v1/models/${modelId}`, options);
   }
 
   /**
-   * List all models.
+   * List models using the OpenAI API.
    */
   list(options?: Core.RequestOptions): Core.APIPromise<ModelListResponse> {
     return (
@@ -31,14 +33,22 @@ export class Models extends APIResource {
   }
 
   /**
+   * Register model.
+   *
    * Register a model.
+   *
+   * @deprecated
    */
-  register(body: ModelRegisterParams, options?: Core.RequestOptions): Core.APIPromise<Model> {
+  register(body: ModelRegisterParams, options?: Core.RequestOptions): Core.APIPromise<ModelRegisterResponse> {
     return this._client.post('/v1/models', { body, ...options });
   }
 
   /**
+   * Unregister model.
+   *
    * Unregister a model.
+   *
+   * @deprecated
    */
   unregister(modelId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v1/models/${modelId}`, {
@@ -53,67 +63,104 @@ export interface ListModelsResponse {
 }
 
 /**
- * A model resource representing an AI model registered in Llama Stack.
+ * A model from OpenAI.
+ *
+ * :id: The ID of the model :object: The object type, which will be "model"
+ * :created: The Unix timestamp in seconds when the model was created :owned_by:
+ * The owner of the model :custom_metadata: Llama Stack-specific metadata including
+ * model_type, provider info, and additional metadata
  */
 export interface Model {
+  id: string;
+
+  created: number;
+
+  owned_by: string;
+
+  custom_metadata?: { [key: string]: unknown } | null;
+
+  object?: 'model';
+}
+
+/**
+ * A model resource representing an AI model registered in Llama Stack.
+ */
+export interface ModelRetrieveResponse {
   /**
    * Unique identifier for this resource in llama stack
    */
   identifier: string;
 
   /**
-   * Any additional metadata for this model
-   */
-  metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
-
-  /**
-   * The type of model (LLM or embedding model)
+   * ID of the provider that owns this resource
    */
-  model_type: 'llm' | 'embedding';
+  provider_id: string;
 
   /**
-   * ID of the provider that owns this resource
+   * Any additional metadata for this model
    */
-  provider_id: string;
+  metadata?: { [key: string]: unknown };
 
   /**
-   * The resource type, always 'model' for model resources
+   * Enumeration of supported model types in Llama Stack.
    */
-  type: 'model';
+  model_type?: 'llm' | 'embedding' | 'rerank';
 
   /**
    * Unique identifier for this resource in the provider
    */
-  provider_resource_id?: string;
+  provider_resource_id?: string | null;
+
+  type?: 'model';
 }
 
 export type ModelListResponse = Array<Model>;
 
-export interface ModelRegisterParams {
+/**
+ * A model resource representing an AI model registered in Llama Stack.
+ */
+export interface ModelRegisterResponse {
   /**
-   * The identifier of the model to register.
+   * Unique identifier for this resource in llama stack
    */
-  model_id: string;
+  identifier: string;
+
+  /**
+   * ID of the provider that owns this resource
+   */
+  provider_id: string;
 
   /**
-   * Any additional metadata for this model.
+   * Any additional metadata for this model
    */
-  metadata?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+  metadata?: { [key: string]: unknown };
 
   /**
-   * The type of model to register.
+   * Enumeration of supported model types in Llama Stack.
    */
-  model_type?: 'llm' | 'embedding';
+  model_type?: 'llm' | 'embedding' | 'rerank';
 
   /**
-   * The identifier of the provider.
+   * Unique identifier for this resource in the provider
    */
-  provider_id?: string;
+  provider_resource_id?: string | null;
+
+  type?: 'model';
+}
+
+export interface ModelRegisterParams {
+  model_id: string;
+
+  metadata?: { [key: string]: unknown } | null;
 
   /**
-   * The identifier of the model in the provider.
+   * Enumeration of supported model types in Llama Stack.
    */
-  provider_model_id?: string;
+  model_type?: 'llm' | 'embedding' | 'rerank' | null;
+
+  provider_id?: string | null;
+
+  provider_model_id?: string | null;
 }
 
 Models.OpenAI = OpenAI;
@@ -122,9 +169,11 @@ export declare namespace Models {
   export {
     type ListModelsResponse as ListModelsResponse,
     type Model as Model,
+    type ModelRetrieveResponse as ModelRetrieveResponse,
     type ModelListResponse as ModelListResponse,
+    type ModelRegisterResponse as ModelRegisterResponse,
     type ModelRegisterParams as ModelRegisterParams,
   };
 
-  export { OpenAI as OpenAI, type OpenAIListResponse as OpenAIListResponse };
+  export { OpenAI as OpenAI };
 }

package/src/resources/models/openai.ts

@@ -3,40 +3,20 @@
 //
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
-
+//
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../resource';
 import * as Core from '../../core';
+import * as ModelsAPI from './models';
 
 export class OpenAI extends APIResource {
   /**
    * List models using the OpenAI API.
    */
-  list(options?: Core.RequestOptions): Core.APIPromise<OpenAIListResponse> {
+  list(options?: Core.RequestOptions): Core.APIPromise<ModelsAPI.ModelListResponse> {
     return (
-      this._client.get('/v1/openai/v1/models', options) as Core.APIPromise<{ data: OpenAIListResponse }>
+      this._client.get('/v1/models', options) as Core.APIPromise<{ data: ModelsAPI.ModelListResponse }>
     )._thenUnwrap((obj) => obj.data);
   }
 }
-
-export type OpenAIListResponse = Array<OpenAIListResponse.OpenAIListResponseItem>;
-
-export namespace OpenAIListResponse {
-  /**
-   * A model from OpenAI.
-   */
-  export interface OpenAIListResponseItem {
-    id: string;
-
-    created: number;
-
-    object: 'model';
-
-    owned_by: string;
-  }
-}
-
-export declare namespace OpenAI {
-  export { type OpenAIListResponse as OpenAIListResponse };
-}

package/src/resources/models.ts

@@ -3,7 +3,7 @@
 //
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
-
+//
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export * from './models/index';

package/src/resources/moderations.ts

@@ -3,7 +3,7 @@
 //
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
-
+//
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../resource';
@@ -11,10 +11,12 @@ import * as Core from '../core';
 
 export class Moderations extends APIResource {
   /**
+   * Create moderation.
+   *
    * Classifies if text and/or image inputs are potentially harmful.
    */
   create(body: ModerationCreateParams, options?: Core.RequestOptions): Core.APIPromise<CreateResponse> {
-    return this._client.post('/v1/openai/v1/moderations', { body, ...options });
+    return this._client.post('/v1/moderations', { body, ...options });
   }
 }
 
@@ -22,19 +24,10 @@ export class Moderations extends APIResource {
  * A moderation object.
  */
 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 objects
-   */
   results: Array<CreateResponse.Result>;
 }
 
@@ -43,43 +36,24 @@ export namespace CreateResponse {
    * A moderation object.
    */
   export interface Result {
-    /**
-     * Whether any of the below categories are flagged.
-     */
     flagged: boolean;
 
-    metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+    categories?: { [key: string]: boolean } | null;
 
-    /**
-     * A list of the categories, and whether they are flagged or not.
-     */
-    categories?: { [key: string]: boolean };
+    category_applied_input_types?: { [key: string]: Array<string> } | null;
 
-    /**
-     * A list of the categories along with the input type(s) that the score applies to.
-     */
-    category_applied_input_types?: { [key: string]: Array<string> };
+    category_scores?: { [key: string]: number } | null;
 
-    /**
-     * A list of the categories along with their scores as predicted by model.
-     */
-    category_scores?: { [key: string]: number };
+    metadata?: { [key: string]: unknown };
 
-    user_message?: string;
+    user_message?: string | null;
   }
 }
 
 export interface ModerationCreateParams {
-  /**
-   * Input (or inputs) to classify. Can be a single string, an array of strings, or
-   * an array of multi-modal input objects similar to other models.
-   */
   input: string | Array<string>;
 
-  /**
-   * The content moderation model you would like to use.
-   */
-  model: string;
+  model?: string | null;
 }
 
 export declare namespace Moderations {

package/src/resources/prompts/index.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Prompts,
+  type ListPromptsResponse,
+  type Prompt,
+  type PromptListResponse,
+  type PromptCreateParams,
+  type PromptRetrieveParams,
+  type PromptUpdateParams,
+  type PromptSetDefaultVersionParams,
+} from './prompts';
+export { Versions } from './versions';

package/src/resources/prompts/prompts.ts

@@ -0,0 +1,171 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as VersionsAPI from './versions';
+import { Versions } from './versions';
+
+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> {
+    return this._client.post('/v1/prompts', { body, ...options });
+  }
+
+  /**
+   * Get prompt.
+   *
+   * Get a prompt by its identifier and optional version.
+   */
+  retrieve(
+    promptId: string,
+    query?: PromptRetrieveParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Prompt>;
+  retrieve(promptId: string, options?: Core.RequestOptions): Core.APIPromise<Prompt>;
+  retrieve(
+    promptId: string,
+    query: PromptRetrieveParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Prompt> {
+    if (isRequestOptions(query)) {
+      return this.retrieve(promptId, {}, query);
+    }
+    return this._client.get(`/v1/prompts/${promptId}`, { query, ...options });
+  }
+
+  /**
+   * 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 });
+  }
+
+  /**
+   * List all prompts.
+   */
+  list(options?: Core.RequestOptions): Core.APIPromise<PromptListResponse> {
+    return (
+      this._client.get('/v1/prompts', options) as Core.APIPromise<{ data: PromptListResponse }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
+  /**
+   * Delete prompt.
+   *
+   * Delete a prompt.
+   */
+  delete(promptId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
+    return this._client.delete(`/v1/prompts/${promptId}`, {
+      ...options,
+      headers: { Accept: '*/*', ...options?.headers },
+    });
+  }
+
+  /**
+   * Set prompt version.
+   *
+   * Set which version of a prompt should be the default in get_prompt (latest).
+   */
+  setDefaultVersion(
+    promptId: string,
+    body: PromptSetDefaultVersionParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<Prompt> {
+    return this._client.post(`/v1/prompts/${promptId}/set-default-version`, { body, ...options });
+  }
+}
+
+/**
+ * Response model to list prompts.
+ */
+export interface ListPromptsResponse {
+  data: PromptListResponse;
+}
+
+/**
+ * A prompt resource representing a stored OpenAI Compatible prompt template in
+ * Llama Stack.
+ */
+export interface Prompt {
+  /**
+   * Unique identifier in format 'pmpt\_<48-digit-hash>'
+   */
+  prompt_id: string;
+
+  /**
+   * Version (integer starting at 1, incremented on save)
+   */
+  version: number;
+
+  /**
+   * Boolean indicating whether this version is the default version
+   */
+  is_default?: boolean;
+
+  /**
+   * The system prompt with variable placeholders
+   */
+  prompt?: string | null;
+
+  /**
+   * List of variable names that can be used in the prompt template
+   */
+  variables?: Array<string>;
+}
+
+export type PromptListResponse = Array<Prompt>;
+
+export interface PromptCreateParams {
+  prompt: string;
+
+  variables?: Array<string> | null;
+}
+
+export interface PromptRetrieveParams {
+  version?: number | null;
+}
+
+export interface PromptUpdateParams {
+  prompt: string;
+
+  version: number;
+
+  set_as_default?: boolean;
+
+  variables?: Array<string> | null;
+}
+
+export interface PromptSetDefaultVersionParams {
+  version: number;
+}
+
+Prompts.Versions = Versions;
+
+export declare namespace Prompts {
+  export {
+    type ListPromptsResponse as ListPromptsResponse,
+    type Prompt as Prompt,
+    type PromptListResponse as PromptListResponse,
+    type PromptCreateParams as PromptCreateParams,
+    type PromptRetrieveParams as PromptRetrieveParams,
+    type PromptUpdateParams as PromptUpdateParams,
+    type PromptSetDefaultVersionParams as PromptSetDefaultVersionParams,
+  };
+
+  export { Versions as Versions };
+}

package/src/resources/prompts/versions.ts

@@ -0,0 +1,26 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+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> {
+    return (
+      this._client.get(`/v1/prompts/${promptId}/versions`, options) as Core.APIPromise<{
+        data: PromptsAPI.PromptListResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+}

package/src/resources/prompts.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Meta Platforms, Inc. and affiliates.
+// All rights reserved.
+//
+// This source code is licensed under the terms described in the LICENSE file in
+// the root directory of this source tree.
+//
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './prompts/index';

package/src/resources/providers.ts

@@ -3,7 +3,7 @@
 //
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
-
+//
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../resource';
@@ -12,6 +12,8 @@ import * as InspectAPI from './inspect';
 
 export class Providers extends APIResource {
   /**
+   * Get provider.
+   *
    * Get detailed information about a specific provider.
    */
   retrieve(providerId: string, options?: Core.RequestOptions): Core.APIPromise<InspectAPI.ProviderInfo> {
@@ -19,6 +21,8 @@ export class Providers extends APIResource {
   }
 
   /**
+   * List providers.
+   *
    * List all available providers.
    */
   list(options?: Core.RequestOptions): Core.APIPromise<ProviderListResponse> {
@@ -32,15 +36,9 @@ export class Providers extends APIResource {
  * Response containing a list of all available providers.
  */
 export interface ListProvidersResponse {
-  /**
-   * List of provider information objects
-   */
   data: ProviderListResponse;
 }
 
-/**
- * List of provider information objects
- */
 export type ProviderListResponse = Array<InspectAPI.ProviderInfo>;
 
 export declare namespace Providers {

package/src/resources/responses/index.ts

@@ -3,7 +3,7 @@
 //
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
-
+//
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export { InputItems, type InputItemListResponse, type InputItemListParams } from './input-items';