llama-stack-client 0.4.3 → 0.4.5

package/src/resources/conversations/items.ts

@@ -13,8 +13,6 @@ import { OpenAICursorPage, type OpenAICursorPageParams } from '../../pagination'
 
 export class Items extends APIResource {
   /**
-   * Create items.
-   *
    * Create items in the conversation.
    */
   create(
@@ -26,8 +24,6 @@ export class Items extends APIResource {
   }
 
   /**
-   * List items.
-   *
    * List items in the conversation.
    */
   list(
@@ -55,8 +51,6 @@ export class Items extends APIResource {
   }
 
   /**
-   * Delete an item.
-   *
    * Delete a conversation item.
    */
   delete(
@@ -68,8 +62,6 @@ export class Items extends APIResource {
   }
 
   /**
-   * Retrieve an item.
-   *
    * Retrieve a conversation item.
    */
   get(
@@ -258,17 +250,26 @@ export namespace ItemCreateResponse {
       /**
        * 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;
       }
 
@@ -276,15 +277,21 @@ export namespace ItemCreateResponse {
         /**
          * 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;
         }
       }
@@ -603,17 +610,26 @@ export namespace ItemListResponse {
       /**
        * 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;
       }
 
@@ -621,15 +637,21 @@ export namespace ItemListResponse {
         /**
          * 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;
         }
       }
@@ -822,178 +844,366 @@ export interface ItemDeleteResponse {
  * under one type because the Responses API gives them all the same "type" value,
  * and there is no way to tell them apart in certain scenarios.
  */
-export interface ItemGetResponse {
-  content:
-    | string
-    | Array<
-        | ItemGetResponse.OpenAIResponseInputMessageContentText
-        | ItemGetResponse.OpenAIResponseInputMessageContentImage
-        | ItemGetResponse.OpenAIResponseInputMessageContentFile
-      >
-    | Array<
-        | ItemGetResponse.OpenAIResponseOutputMessageContentOutputText
-        | ItemGetResponse.OpenAIResponseContentPartRefusal
+export type ItemGetResponse =
+  | ItemGetResponse.OpenAIResponseMessageOutput
+  | ItemGetResponse.OpenAIResponseOutputMessageWebSearchToolCall
+  | ItemGetResponse.OpenAIResponseOutputMessageFileSearchToolCall
+  | ItemGetResponse.OpenAIResponseOutputMessageFunctionToolCall
+  | ItemGetResponse.OpenAIResponseInputFunctionToolCallOutput
+  | ItemGetResponse.OpenAIResponseMcpApprovalRequest
+  | ItemGetResponse.OpenAIResponseMcpApprovalResponse
+  | ItemGetResponse.OpenAIResponseOutputMessageMcpCall
+  | ItemGetResponse.OpenAIResponseOutputMessageMcpListTools;
+
+export namespace ItemGetResponse {
+  /**
+   * Corresponds to the various Message types in the Responses API. They are all
+   * under one type because the Responses API gives them all the same "type" value,
+   * and there is no way to tell them apart in certain scenarios.
+   */
+  export interface OpenAIResponseMessageOutput {
+    content:
+      | string
+      | Array<
+          | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentText
+          | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentImage
+          | OpenAIResponseMessageOutput.OpenAIResponseInputMessageContentFile
+        >
+      | Array<
+          | OpenAIResponseMessageOutput.OpenAIResponseOutputMessageContentOutputTextOutput
+          | OpenAIResponseMessageOutput.OpenAIResponseContentPartRefusal
+        >;
+
+    role: 'system' | 'developer' | 'user' | 'assistant';
+
+    id?: string | null;
+
+    status?: string | null;
+
+    type?: 'message';
+  }
+
+  export namespace OpenAIResponseMessageOutput {
+    /**
+     * 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';
+    }
+
+    export interface OpenAIResponseOutputMessageContentOutputTextOutput {
+      text: string;
+
+      annotations?: Array<
+        | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFileCitation
+        | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationCitation
+        | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationContainerFileCitation
+        | OpenAIResponseOutputMessageContentOutputTextOutput.OpenAIResponseAnnotationFilePath
       >;
 
-  role: 'system' | 'developer' | 'user' | 'assistant';
+      logprobs?: Array<OpenAIResponseOutputMessageContentOutputTextOutput.Logprob> | null;
 
-  id?: string | null;
+      type?: 'output_text';
+    }
 
-  status?: string | null;
+    export namespace OpenAIResponseOutputMessageContentOutputTextOutput {
+      /**
+       * File citation annotation for referencing specific files in response content.
+       */
+      export interface OpenAIResponseAnnotationFileCitation {
+        file_id: string;
 
-  type?: 'message';
-}
+        filename: string;
 
-export namespace ItemGetResponse {
-  /**
-   * Text content for input messages in OpenAI response format.
-   */
-  export interface OpenAIResponseInputMessageContentText {
-    text: string;
+        index: number;
 
-    type?: 'input_text';
-  }
+        type?: 'file_citation';
+      }
 
-  /**
-   * Image content for input messages in OpenAI response format.
-   */
-  export interface OpenAIResponseInputMessageContentImage {
-    detail?: 'low' | 'high' | 'auto';
+      /**
+       * URL citation annotation for referencing external web resources.
+       */
+      export interface OpenAIResponseAnnotationCitation {
+        end_index: number;
+
+        start_index: number;
 
-    file_id?: string | null;
+        title: string;
+
+        url: string;
 
-    image_url?: string | null;
+        type?: 'url_citation';
+      }
 
-    type?: 'input_image';
+      export interface OpenAIResponseAnnotationContainerFileCitation {
+        container_id: string;
+
+        end_index: number;
+
+        file_id: string;
+
+        filename: string;
+
+        start_index: number;
+
+        type?: 'container_file_citation';
+      }
+
+      export interface OpenAIResponseAnnotationFilePath {
+        file_id: string;
+
+        index: number;
+
+        type?: 'file_path';
+      }
+
+      /**
+       * The log probability for a token from an OpenAI-compatible chat completion
+       * response.
+       */
+      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;
+      }
+
+      export namespace Logprob {
+        /**
+         * The top log probability for a token from an OpenAI-compatible chat completion
+         * response.
+         */
+        export interface TopLogprob {
+          /**
+           * The token.
+           */
+          token: string;
+
+          /**
+           * The log probability of the token.
+           */
+          logprob: number;
+
+          /**
+           * The bytes for the token.
+           */
+          bytes?: Array<number> | null;
+        }
+      }
+    }
+
+    /**
+     * Refusal content within a streamed response part.
+     */
+    export interface OpenAIResponseContentPartRefusal {
+      refusal: string;
+
+      type?: 'refusal';
+    }
   }
 
   /**
-   * File content for input messages in OpenAI response format.
+   * Web search tool call output message for OpenAI responses.
    */
-  export interface OpenAIResponseInputMessageContentFile {
-    file_data?: string | null;
-
-    file_id?: string | null;
-
-    file_url?: string | null;
+  export interface OpenAIResponseOutputMessageWebSearchToolCall {
+    id: string;
 
-    filename?: string | null;
+    status: string;
 
-    type?: 'input_file';
+    type?: 'web_search_call';
   }
 
-  export interface OpenAIResponseOutputMessageContentOutputText {
-    text: string;
+  /**
+   * File search tool call output message for OpenAI responses.
+   */
+  export interface OpenAIResponseOutputMessageFileSearchToolCall {
+    id: string;
 
-    annotations?: Array<
-      | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFileCitation
-      | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationCitation
-      | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationContainerFileCitation
-      | OpenAIResponseOutputMessageContentOutputText.OpenAIResponseAnnotationFilePath
-    >;
+    queries: Array<string>;
 
-    logprobs?: Array<OpenAIResponseOutputMessageContentOutputText.Logprob> | null;
+    status: string;
 
-    type?: 'output_text';
+    results?: Array<OpenAIResponseOutputMessageFileSearchToolCall.Result> | null;
+
+    type?: 'file_search_call';
   }
 
-  export namespace OpenAIResponseOutputMessageContentOutputText {
+  export namespace OpenAIResponseOutputMessageFileSearchToolCall {
     /**
-     * File citation annotation for referencing specific files in response content.
+     * Search results returned by the file search operation.
      */
-    export interface OpenAIResponseAnnotationFileCitation {
+    export interface Result {
+      attributes: { [key: string]: unknown };
+
       file_id: string;
 
       filename: string;
 
-      index: number;
+      score: number;
 
-      type?: 'file_citation';
+      text: string;
     }
+  }
 
-    /**
-     * URL citation annotation for referencing external web resources.
-     */
-    export interface OpenAIResponseAnnotationCitation {
-      end_index: number;
+  /**
+   * Function tool call output message for OpenAI responses.
+   */
+  export interface OpenAIResponseOutputMessageFunctionToolCall {
+    arguments: string;
 
-      start_index: number;
+    call_id: string;
 
-      title: string;
+    name: string;
 
-      url: string;
+    id?: string | null;
 
-      type?: 'url_citation';
-    }
+    status?: string | null;
 
-    export interface OpenAIResponseAnnotationContainerFileCitation {
-      container_id: string;
+    type?: 'function_call';
+  }
 
-      end_index: number;
+  /**
+   * This represents the output of a function call that gets passed back to the
+   * model.
+   */
+  export interface OpenAIResponseInputFunctionToolCallOutput {
+    call_id: string;
 
-      file_id: string;
+    output: string;
 
-      filename: string;
+    id?: string | null;
 
-      start_index: number;
+    status?: string | null;
 
-      type?: 'container_file_citation';
-    }
+    type?: 'function_call_output';
+  }
 
-    export interface OpenAIResponseAnnotationFilePath {
-      file_id: string;
+  /**
+   * A request for human approval of a tool invocation.
+   */
+  export interface OpenAIResponseMcpApprovalRequest {
+    id: string;
 
-      index: number;
+    arguments: string;
 
-      type?: 'file_path';
-    }
+    name: string;
 
-    /**
-     * 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 {
-      token: string;
+    server_label: string;
 
-      logprob: number;
+    type?: 'mcp_approval_request';
+  }
 
-      bytes?: Array<number> | null;
+  /**
+   * A response to an MCP approval request.
+   */
+  export interface OpenAIResponseMcpApprovalResponse {
+    approval_request_id: string;
 
-      top_logprobs?: Array<Logprob.TopLogprob> | null;
-    }
+    approve: boolean;
 
-    export namespace Logprob {
-      /**
-       * 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 {
-        token: string;
+    id?: string | null;
 
-        logprob: number;
+    reason?: string | null;
 
-        bytes?: Array<number> | null;
-      }
-    }
+    type?: 'mcp_approval_response';
   }
 
   /**
-   * Refusal content within a streamed response part.
+   * Model Context Protocol (MCP) call output message for OpenAI responses.
    */
-  export interface OpenAIResponseContentPartRefusal {
-    refusal: string;
+  export interface OpenAIResponseOutputMessageMcpCall {
+    id: string;
+
+    arguments: string;
 
-    type?: 'refusal';
+    name: string;
+
+    server_label: string;
+
+    error?: string | null;
+
+    output?: string | null;
+
+    type?: 'mcp_call';
+  }
+
+  /**
+   * MCP list tools output message containing available tools from an MCP server.
+   */
+  export interface OpenAIResponseOutputMessageMcpListTools {
+    id: string;
+
+    server_label: string;
+
+    tools: Array<OpenAIResponseOutputMessageMcpListTools.Tool>;
+
+    type?: 'mcp_list_tools';
+  }
+
+  export namespace OpenAIResponseOutputMessageMcpListTools {
+    /**
+     * Tool definition returned by MCP list tools operation.
+     */
+    export interface Tool {
+      input_schema: { [key: string]: unknown };
+
+      name: string;
+
+      description?: string | null;
+    }
   }
 }
 
 export interface ItemCreateParams {
+  /**
+   * Items to include in the conversation context. You may add up to 20 items at a
+   * time.
+   */
   items: Array<
     | ItemCreateParams.OpenAIResponseMessageInput
     | ItemCreateParams.OpenAIResponseOutputMessageWebSearchToolCall
@@ -1142,17 +1352,26 @@ export namespace ItemCreateParams {
       /**
        * 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;
       }
 
@@ -1160,15 +1379,21 @@ export namespace ItemCreateParams {
         /**
          * 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;
         }
       }