llama-stack-client 0.3.4 → 0.4.0-rc1

package/src/resources/vector-io.ts

@@ -3,12 +3,11 @@
 //
 // 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 Shared from './shared';
 
 export class VectorIo extends APIResource {
   /**
@@ -34,14 +33,8 @@ export class VectorIo extends APIResource {
  * Response from querying chunks in a vector database.
  */
 export interface QueryChunksResponse {
-  /**
-   * List of content chunks returned from the query
-   */
   chunks: Array<QueryChunksResponse.Chunk>;
 
-  /**
-   * Relevance scores corresponding to each returned chunk
-   */
   scores: Array<number>;
 }
 
@@ -50,119 +43,161 @@ export namespace QueryChunksResponse {
    * A chunk of content that can be inserted into a vector database.
    */
   export interface Chunk {
-    /**
-     * The content of the chunk, which can be interleaved text, images, or other types.
-     */
-    content: Shared.InterleavedContent;
+    chunk_id: string;
 
     /**
-     * Metadata associated with the chunk that will be used in the model context during
-     * inference.
+     * A image content item
      */
-    metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+    content:
+      | string
+      | Chunk.ImageContentItemOutput
+      | Chunk.TextContentItem
+      | Array<Chunk.ImageContentItemOutput | Chunk.TextContentItem>;
 
     /**
-     * Metadata for the chunk that will NOT be used in the context during inference.
-     * The `chunk_metadata` is required backend functionality.
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
      */
-    chunk_metadata?: Chunk.ChunkMetadata;
+    chunk_metadata?: Chunk.ChunkMetadata | null;
 
-    /**
-     * Optional embedding for the chunk. If not provided, it will be computed later.
-     */
-    embedding?: Array<number>;
+    embedding?: Array<number> | null;
 
-    /**
-     * The chunk ID that is stored in the vector database. Used for backend
-     * functionality.
-     */
-    stored_chunk_id?: string;
+    metadata?: { [key: string]: unknown };
   }
 
   export namespace Chunk {
     /**
-     * Metadata for the chunk that will NOT be used in the context during inference.
-     * The `chunk_metadata` is required backend functionality.
+     * A image content item
      */
-    export interface ChunkMetadata {
+    export interface ImageContentItemOutput {
       /**
-       * The dimension of the embedding vector for the chunk.
+       * A URL or a base64 encoded string
        */
-      chunk_embedding_dimension?: number;
+      image: ImageContentItemOutput.Image;
 
-      /**
-       * The embedding model used to create the chunk's embedding.
-       */
-      chunk_embedding_model?: string;
+      type?: 'image';
+    }
 
+    export namespace ImageContentItemOutput {
       /**
-       * The ID of the chunk. If not set, it will be generated based on the document ID
-       * and content.
+       * A URL or a base64 encoded string
        */
-      chunk_id?: string;
+      export interface Image {
+        data?: string | null;
+
+        /**
+         * A URL reference to external content.
+         */
+        url?: Image.URL | null;
+      }
+
+      export namespace Image {
+        /**
+         * A URL reference to external content.
+         */
+        export interface URL {
+          uri: string;
+        }
+      }
+    }
 
-      /**
-       * The tokenizer used to create the chunk. Default is Tiktoken.
-       */
-      chunk_tokenizer?: string;
+    /**
+     * A text content item
+     */
+    export interface TextContentItem {
+      text: string;
 
-      /**
-       * The window of the chunk, which can be used to group related chunks together.
-       */
-      chunk_window?: string;
+      type?: 'text';
+    }
 
+    /**
+     * A image content item
+     */
+    export interface ImageContentItemOutput {
       /**
-       * The number of tokens in the content of the chunk.
+       * A URL or a base64 encoded string
        */
-      content_token_count?: number;
+      image: ImageContentItemOutput.Image;
 
-      /**
-       * An optional timestamp indicating when the chunk was created.
-       */
-      created_timestamp?: number;
+      type?: 'image';
+    }
 
+    export namespace ImageContentItemOutput {
       /**
-       * The ID of the document this chunk belongs to.
+       * A URL or a base64 encoded string
        */
-      document_id?: string;
+      export interface Image {
+        data?: string | null;
+
+        /**
+         * A URL reference to external content.
+         */
+        url?: Image.URL | null;
+      }
+
+      export namespace Image {
+        /**
+         * A URL reference to external content.
+         */
+        export interface URL {
+          uri: string;
+        }
+      }
+    }
 
-      /**
-       * The number of tokens in the metadata of the chunk.
-       */
-      metadata_token_count?: number;
+    /**
+     * A text content item
+     */
+    export interface TextContentItem {
+      text: string;
 
-      /**
-       * The source of the content, such as a URL, file path, or other identifier.
-       */
-      source?: string;
+      type?: 'text';
+    }
 
-      /**
-       * An optional timestamp indicating when the chunk was last updated.
-       */
-      updated_timestamp?: number;
+    /**
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
+     */
+    export interface ChunkMetadata {
+      chunk_embedding_dimension?: number | null;
+
+      chunk_embedding_model?: string | null;
+
+      chunk_id?: string | null;
+
+      chunk_tokenizer?: string | null;
+
+      chunk_window?: string | null;
+
+      content_token_count?: number | null;
+
+      created_timestamp?: number | null;
+
+      document_id?: string | null;
+
+      metadata_token_count?: number | null;
+
+      source?: string | null;
+
+      updated_timestamp?: number | null;
     }
   }
 }
 
 export interface VectorIoInsertParams {
-  /**
-   * The chunks to insert. Each `Chunk` should contain content which can be
-   * interleaved text, images, or other types. `metadata`: `dict[str, Any]` and
-   * `embedding`: `List[float]` are optional. If `metadata` is provided, you
-   * configure how Llama Stack formats the chunk during generation. If `embedding` is
-   * not provided, it will be computed later.
-   */
   chunks: Array<VectorIoInsertParams.Chunk>;
 
-  /**
-   * The identifier of the vector database to insert the chunks into.
-   */
-  vector_db_id: string;
+  vector_store_id: string;
 
-  /**
-   * The time to live of the chunks.
-   */
-  ttl_seconds?: number;
+  ttl_seconds?: number | null;
 }
 
 export namespace VectorIoInsertParams {
@@ -170,115 +205,258 @@ export namespace VectorIoInsertParams {
    * A chunk of content that can be inserted into a vector database.
    */
   export interface Chunk {
-    /**
-     * The content of the chunk, which can be interleaved text, images, or other types.
-     */
-    content: Shared.InterleavedContent;
+    chunk_id: string;
 
     /**
-     * Metadata associated with the chunk that will be used in the model context during
-     * inference.
+     * A image content item
      */
-    metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+    content:
+      | string
+      | Chunk.ImageContentItemInput
+      | Chunk.TextContentItem
+      | Array<Chunk.ImageContentItemInput | Chunk.TextContentItem>;
 
     /**
-     * Metadata for the chunk that will NOT be used in the context during inference.
-     * The `chunk_metadata` is required backend functionality.
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
      */
-    chunk_metadata?: Chunk.ChunkMetadata;
+    chunk_metadata?: Chunk.ChunkMetadata | null;
 
-    /**
-     * Optional embedding for the chunk. If not provided, it will be computed later.
-     */
-    embedding?: Array<number>;
+    embedding?: Array<number> | null;
 
-    /**
-     * The chunk ID that is stored in the vector database. Used for backend
-     * functionality.
-     */
-    stored_chunk_id?: string;
+    metadata?: { [key: string]: unknown };
   }
 
   export namespace Chunk {
     /**
-     * Metadata for the chunk that will NOT be used in the context during inference.
-     * The `chunk_metadata` is required backend functionality.
+     * A image content item
      */
-    export interface ChunkMetadata {
+    export interface ImageContentItemInput {
       /**
-       * The dimension of the embedding vector for the chunk.
+       * A URL or a base64 encoded string
        */
-      chunk_embedding_dimension?: number;
+      image: ImageContentItemInput.Image;
 
-      /**
-       * The embedding model used to create the chunk's embedding.
-       */
-      chunk_embedding_model?: string;
+      type?: 'image';
+    }
 
+    export namespace ImageContentItemInput {
       /**
-       * The ID of the chunk. If not set, it will be generated based on the document ID
-       * and content.
+       * A URL or a base64 encoded string
        */
-      chunk_id?: string;
+      export interface Image {
+        data?: string | null;
+
+        /**
+         * A URL reference to external content.
+         */
+        url?: Image.URL | null;
+      }
+
+      export namespace Image {
+        /**
+         * A URL reference to external content.
+         */
+        export interface URL {
+          uri: string;
+        }
+      }
+    }
 
-      /**
-       * The tokenizer used to create the chunk. Default is Tiktoken.
-       */
-      chunk_tokenizer?: string;
+    /**
+     * A text content item
+     */
+    export interface TextContentItem {
+      text: string;
 
-      /**
-       * The window of the chunk, which can be used to group related chunks together.
-       */
-      chunk_window?: string;
+      type?: 'text';
+    }
 
+    /**
+     * A image content item
+     */
+    export interface ImageContentItemInput {
       /**
-       * The number of tokens in the content of the chunk.
+       * A URL or a base64 encoded string
        */
-      content_token_count?: number;
+      image: ImageContentItemInput.Image;
 
-      /**
-       * An optional timestamp indicating when the chunk was created.
-       */
-      created_timestamp?: number;
+      type?: 'image';
+    }
 
+    export namespace ImageContentItemInput {
       /**
-       * The ID of the document this chunk belongs to.
+       * A URL or a base64 encoded string
        */
-      document_id?: string;
+      export interface Image {
+        data?: string | null;
+
+        /**
+         * A URL reference to external content.
+         */
+        url?: Image.URL | null;
+      }
+
+      export namespace Image {
+        /**
+         * A URL reference to external content.
+         */
+        export interface URL {
+          uri: string;
+        }
+      }
+    }
 
-      /**
-       * The number of tokens in the metadata of the chunk.
-       */
-      metadata_token_count?: number;
+    /**
+     * A text content item
+     */
+    export interface TextContentItem {
+      text: string;
+
+      type?: 'text';
+    }
+
+    /**
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
+     */
+    export interface ChunkMetadata {
+      chunk_embedding_dimension?: number | null;
+
+      chunk_embedding_model?: string | null;
+
+      chunk_id?: string | null;
+
+      chunk_tokenizer?: string | null;
+
+      chunk_window?: string | null;
+
+      content_token_count?: number | null;
+
+      created_timestamp?: number | null;
+
+      document_id?: string | null;
+
+      metadata_token_count?: number | null;
+
+      source?: string | null;
+
+      updated_timestamp?: number | null;
+    }
+  }
+}
+
+export interface VectorIoQueryParams {
+  /**
+   * A image content item
+   */
+  query:
+    | string
+    | VectorIoQueryParams.ImageContentItemInput
+    | VectorIoQueryParams.TextContentItem
+    | Array<VectorIoQueryParams.ImageContentItemInput | VectorIoQueryParams.TextContentItem>;
+
+  vector_store_id: string;
+
+  params?: { [key: string]: unknown } | null;
+}
+
+export namespace VectorIoQueryParams {
+  /**
+   * A image content item
+   */
+  export interface ImageContentItemInput {
+    /**
+     * A URL or a base64 encoded string
+     */
+    image: ImageContentItemInput.Image;
+
+    type?: 'image';
+  }
+
+  export namespace ImageContentItemInput {
+    /**
+     * A URL or a base64 encoded string
+     */
+    export interface Image {
+      data?: string | null;
 
       /**
-       * The source of the content, such as a URL, file path, or other identifier.
+       * A URL reference to external content.
        */
-      source?: string;
+      url?: Image.URL | null;
+    }
 
+    export namespace Image {
       /**
-       * An optional timestamp indicating when the chunk was last updated.
+       * A URL reference to external content.
        */
-      updated_timestamp?: number;
+      export interface URL {
+        uri: string;
+      }
     }
   }
-}
 
-export interface VectorIoQueryParams {
   /**
-   * The query to search for.
+   * A text content item
    */
-  query: Shared.InterleavedContent;
+  export interface TextContentItem {
+    text: string;
+
+    type?: 'text';
+  }
 
   /**
-   * The identifier of the vector database to query.
+   * A image content item
    */
-  vector_db_id: string;
+  export interface ImageContentItemInput {
+    /**
+     * A URL or a base64 encoded string
+     */
+    image: ImageContentItemInput.Image;
+
+    type?: 'image';
+  }
+
+  export namespace ImageContentItemInput {
+    /**
+     * A URL or a base64 encoded string
+     */
+    export interface Image {
+      data?: string | null;
+
+      /**
+       * A URL reference to external content.
+       */
+      url?: Image.URL | null;
+    }
+
+    export namespace Image {
+      /**
+       * A URL reference to external content.
+       */
+      export interface URL {
+        uri: string;
+      }
+    }
+  }
 
   /**
-   * The parameters of the query.
+   * A text content item
    */
-  params?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
+  export interface TextContentItem {
+    text: string;
+
+    type?: 'text';
+  }
 }
 
 export declare namespace VectorIo {