llama-stack-client 0.4.3 → 0.4.5

package/src/resources/completions.ts

@@ -14,8 +14,6 @@ import { Stream } from '../streaming';
 
 export class Completions extends APIResource {
   /**
-   * Create completion.
-   *
    * Generate an OpenAI-compatible completion for the given prompt using the
    * specified model.
    */
@@ -43,37 +41,52 @@ export class Completions extends APIResource {
 
 /**
  * Response from an OpenAI-compatible completion request.
- *
- * :id: The ID of the completion :choices: List of choices :created: The Unix
- * timestamp in seconds when the completion was created :model: The model that was
- * used to generate the completion :object: The object type, which will be
- * "text_completion"
  */
 export interface CompletionCreateResponse {
+  /**
+   * The ID of the completion.
+   */
   id: string;
 
+  /**
+   * List of choices.
+   */
   choices: Array<CompletionCreateResponse.Choice>;
 
+  /**
+   * The Unix timestamp in seconds when the completion was created.
+   */
   created: number;
 
+  /**
+   * The model that was used to generate the completion.
+   */
   model: string;
 
+  /**
+   * The object type.
+   */
   object?: 'text_completion';
 }
 
 export namespace CompletionCreateResponse {
   /**
    * A choice from an OpenAI-compatible completion response.
-   *
-   * :finish_reason: The reason the model stopped generating :text: The text of the
-   * choice :index: The index of the choice :logprobs: (Optional) The log
-   * probabilities for the tokens in the choice
    */
   export interface Choice {
-    finish_reason: string;
+    /**
+     * The reason the model stopped generating.
+     */
+    finish_reason: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call';
 
+    /**
+     * The index of the choice.
+     */
     index: number;
 
+    /**
+     * The text of the choice.
+     */
     text: string;
 
     /**
@@ -89,8 +102,14 @@ export namespace CompletionCreateResponse {
      * chat completion response.
      */
     export interface Logprobs {
+      /**
+       * The log probabilities for the tokens in the message.
+       */
       content?: Array<Logprobs.Content> | null;
 
+      /**
+       * The log probabilities for the refusal tokens.
+       */
       refusal?: Array<Logprobs.Refusal> | null;
     }
 
@@ -98,17 +117,26 @@ export namespace CompletionCreateResponse {
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
-       *
-       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Content {
+        /**
+         * The token.
+         */
         token: string;
 
+        /**
+         * The log probability of the token.
+         */
         logprob: number;
 
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
 
+        /**
+         * The top log probabilities for the token.
+         */
         top_logprobs?: Array<Content.TopLogprob> | null;
       }
 
@@ -116,15 +144,21 @@ export namespace CompletionCreateResponse {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
-         *
-         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-         * probability of the token
          */
         export interface TopLogprob {
+          /**
+           * The token.
+           */
           token: string;
 
+          /**
+           * The log probability of the token.
+           */
           logprob: number;
 
+          /**
+           * The bytes for the token.
+           */
           bytes?: Array<number> | null;
         }
       }
@@ -132,17 +166,26 @@ export namespace CompletionCreateResponse {
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
-       *
-       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Refusal {
+        /**
+         * The token.
+         */
         token: string;
 
+        /**
+         * The log probability of the token.
+         */
         logprob: number;
 
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
 
+        /**
+         * The top log probabilities for the token.
+         */
         top_logprobs?: Array<Refusal.TopLogprob> | null;
       }
 
@@ -150,15 +193,21 @@ export namespace CompletionCreateResponse {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
-         *
-         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-         * probability of the token
          */
         export interface TopLogprob {
+          /**
+           * The token.
+           */
           token: string;
 
+          /**
+           * The log probability of the token.
+           */
           logprob: number;
 
+          /**
+           * The bytes for the token.
+           */
           bytes?: Array<number> | null;
         }
       }
@@ -169,40 +218,94 @@ export namespace CompletionCreateResponse {
 export type CompletionCreateParams = CompletionCreateParamsNonStreaming | CompletionCreateParamsStreaming;
 
 export interface CompletionCreateParamsBase {
+  /**
+   * The identifier of the model to use.
+   */
   model: string;
 
+  /**
+   * The prompt to generate a completion for.
+   */
   prompt: string | Array<string> | Array<number> | Array<Array<number>>;
 
+  /**
+   * The number of completions to generate.
+   */
   best_of?: number | null;
 
+  /**
+   * Whether to echo the prompt.
+   */
   echo?: boolean | null;
 
+  /**
+   * The penalty for repeated tokens.
+   */
   frequency_penalty?: number | null;
 
+  /**
+   * The logit bias to use.
+   */
   logit_bias?: { [key: string]: number } | null;
 
+  /**
+   * The log probabilities to use.
+   */
   logprobs?: boolean | null;
 
+  /**
+   * The maximum number of tokens to generate.
+   */
   max_tokens?: number | null;
 
+  /**
+   * The number of completions to generate.
+   */
   n?: number | null;
 
+  /**
+   * The penalty for repeated tokens.
+   */
   presence_penalty?: number | null;
 
+  /**
+   * The seed to use.
+   */
   seed?: number | null;
 
+  /**
+   * The stop tokens to use.
+   */
   stop?: string | Array<string> | null;
 
+  /**
+   * Whether to stream the response.
+   */
   stream?: boolean | null;
 
+  /**
+   * The stream options to use.
+   */
   stream_options?: { [key: string]: unknown } | null;
 
+  /**
+   * The suffix that should be appended to the completion.
+   */
   suffix?: string | null;
 
+  /**
+   * The temperature to use.
+   */
   temperature?: number | null;
 
+  /**
+   * The top p to use.
+   */
   top_p?: number | null;
 
+  /**
+   * The user to use.
+   */
   user?: string | null;
 
   [k: string]: unknown;
@@ -214,12 +317,18 @@ export namespace CompletionCreateParams {
 }
 
 export interface CompletionCreateParamsNonStreaming extends CompletionCreateParamsBase {
+  /**
+   * Whether to stream the response.
+   */
   stream?: false | null;
 
   [k: string]: unknown;
 }
 
 export interface CompletionCreateParamsStreaming extends CompletionCreateParamsBase {
+  /**
+   * Whether to stream the response.
+   */
   stream: true;
 
   [k: string]: unknown;

package/src/resources/conversations/conversations.ts

@@ -24,8 +24,6 @@ export class Conversations extends APIResource {
   items: ItemsAPI.Items = new ItemsAPI.Items(this._client);
 
   /**
-   * Create a conversation.
-   *
    * Create a conversation.
    */
   create(body: ConversationCreateParams, options?: Core.RequestOptions): Core.APIPromise<ConversationObject> {
@@ -33,8 +31,6 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Retrieve a conversation.
-   *
    * Get a conversation with the given ID.
    */
   retrieve(conversationId: string, options?: Core.RequestOptions): Core.APIPromise<ConversationObject> {
@@ -42,8 +38,6 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Update a conversation.
-   *
    * Update a conversation's metadata with the given ID.
    */
   update(
@@ -55,8 +49,6 @@ export class Conversations extends APIResource {
   }
 
   /**
-   * Delete a conversation.
-   *
    * Delete a conversation with the given ID.
    */
   delete(conversationId: string, options?: Core.RequestOptions): Core.APIPromise<ConversationDeleteResponse> {
@@ -119,6 +111,9 @@ export interface ConversationDeleteResponse {
 }
 
 export interface ConversationCreateParams {
+  /**
+   * Initial items to include in the conversation context.
+   */
   items?: Array<
     | ConversationCreateParams.OpenAIResponseMessageInput
     | ConversationCreateParams.OpenAIResponseOutputMessageWebSearchToolCall
@@ -131,6 +126,9 @@ export interface ConversationCreateParams {
     | ConversationCreateParams.OpenAIResponseOutputMessageMcpListTools
   > | null;
 
+  /**
+   * Set of key-value pairs that can be attached to an object.
+   */
   metadata?: { [key: string]: string } | null;
 }
 
@@ -269,17 +267,26 @@ export namespace ConversationCreateParams {
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
-       *
-       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Logprob {
+        /**
+         * The token.
+         */
         token: string;
 
+        /**
+         * The log probability of the token.
+         */
         logprob: number;
 
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
 
+        /**
+         * The top log probabilities for the token.
+         */
         top_logprobs?: Array<Logprob.TopLogprob> | null;
       }
 
@@ -287,15 +294,21 @@ export namespace ConversationCreateParams {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
-         *
-         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-         * probability of the token
          */
         export interface TopLogprob {
+          /**
+           * The token.
+           */
           token: string;
 
+          /**
+           * The log probability of the token.
+           */
           logprob: number;
 
+          /**
+           * The bytes for the token.
+           */
           bytes?: Array<number> | null;
         }
       }
@@ -464,6 +477,9 @@ export namespace ConversationCreateParams {
 }
 
 export interface ConversationUpdateParams {
+  /**
+   * Set of key-value pairs that can be attached to an object.
+   */
   metadata: { [key: string]: string };
 }