@upstash/vector 1.1.2 → 1.1.3-canary

package/README.md

@@ -47,7 +47,7 @@ const index = new Index<Metadata>({
   token: "<UPSTASH_VECTOR_REST_TOKEN>",
 });
 
-//Upsert Data
+//Upsert data
 await index.upsert([{
   id: 'upstash-rocks',
   vector: [
@@ -60,7 +60,21 @@ await index.upsert([{
   }
 }])
 
-//Query Data
+// Upsert data as plain text.
+await index.upsert([{
+  id: 'tokyo',
+  data: "Tokyo is the capital of Japan.",
+}])
+
+//Upsert data alongside with your embedding
+await index.upsert([{
+  id: 'tokyo',
+  data: "Tokyo is the capital of Japan.",
+  vector: [......]
+}])
+
+
+//Query data
 const results = await index.query<Metadata>(
   {
     vector: [
@@ -76,9 +90,28 @@ const results = await index.query<Metadata>(
   }
 )
 
+//Query with your data
+const results = await index.query(
+  {
+    data: "Where is the capital of Japan",
+    topK: 1,
+  },
+)
+
+//Query with your data
+const results = await index.query(
+  {
+    vector: [
+      ... // query embedding
+    ],
+    includeData: true, // Returns data associated with your vector.
+    topK: 1,
+  },
+)
+
 // If you wanna learn more about filtering check: [Metadata Filtering](https://upstash.com/docs/vector/features/filtering)
 
-//Update Data
+//Update data
 await index.upsert(
   {
     id: "upstash-rocks",
@@ -102,6 +135,9 @@ await index.delete(["id-1", "id-2", "id-3"]);
 //Fetch records by their IDs
 await index.fetch(["id-1", "id-2"], {namespace: "example-namespace"});
 
+//Fetch records by their IDs
+await index.fetch(["id-1", "id-2"], {namespace: "example-namespace", includeData:true});
+
 //Fetch records with range
 await index.range(
   {
@@ -223,11 +259,7 @@ Make sure you have Bun.js installed and have those relevant keys with specific v
 
 ```bash
 
-## Vector dimension should be 2
+## Vector dimension should be 3842
 UPSTASH_VECTOR_REST_URL="XXXXX"
 UPSTASH_VECTOR_REST_TOKEN="XXXXX"
-
-## Vector dimension should be 384
-EMBEDDING_UPSTASH_VECTOR_REST_URL="XXXXX"
-EMBEDDING_UPSTASH_VECTOR_REST_TOKEN="XXXXX"
 ```

package/dist/chunk-EEOSY6EV.mjs

@@ -0,0 +1 @@
+var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var E=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,s=null;for(let M=0;M<=this.retry.attempts;M++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(A){if(this.options.signal?.aborted){let g=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),P={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(g,P);break}s=A,await new Promise(g=>setTimeout(g,this.retry.backoff(M)))}if(!a)throw s??new Error("Exhausted all retries");let o=await a.json();if(!a.ok)throw new i(`${o.error}`);return{result:o.result,error:o.error}}};var n=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends n{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let s=[];Array.isArray(e)?s.push(...e):s.push(e),super(s,a)}};var f=class extends n{constructor(e,t){let a="query";a=e.some(o=>o.data)?"query-data":"query",t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var d=class extends n{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends n{constructor(e,t){let a="upsert";Array.isArray(e)?a=e.some(o=>R(o))?"upsert":"upsert-data":a=R(e)?"upsert":"upsert-data",t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}},R=r=>"vector"in r;var c=class extends n{constructor([e,t]){let a="fetch";t?.namespace&&(a=`${a}/${t.namespace}`,delete t.namespace),super({ids:e,...t},a)}};var l=class extends n{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends n{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var C=class extends n{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);update=e=>new y(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>(e[1]?e[1].namespace=this.namespace:e[1]={namespace:this.namespace},new c(e).exec(this.client));query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var y=class extends n{constructor(e,t){let a="update";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var x=class extends n{constructor(){super([],"list-namespaces")}};var T=class extends n{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var b=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);queryMany=(e,t)=>new f(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);update=(e,t)=>new y(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new C().exec(this.client);listNamespaces=()=>new x().exec(this.client);deleteNamespace=e=>new T(e).exec(this.client)};export{E as a,b};

package/dist/cloudflare.d.mts

@@ -0,0 +1,60 @@
+import { R as RequesterConfig, D as Dict, I as Index$1 } from './vector-U-xfTq8V.mjs';
+export { F as FetchResult, d as InfoResult, Q as QueryResult, c as RangeResult, a as Requester, U as UpstashRequest, b as UpstashResponse, V as Vector } from './vector-U-xfTq8V.mjs';
+
+/**
+ * Connection credentials for upstash vector.
+ * Get them from https://console.upstash.com/vector/<uuid>
+ */
+type IndexConfig = {
+    /**
+     * UPSTASH_VECTOR_REST_URL
+     */
+    url?: string;
+    /**
+     * UPSTASH_VECTOR_REST_TOKEN
+     */
+    token?: string;
+    /**
+     * The signal will allow aborting requests on the fly.
+     * For more check: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+     */
+    signal?: AbortSignal;
+} & RequesterConfig;
+/**
+ * Serverless vector client for upstash.
+ */
+declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
+    /**
+     * Create a new vector client by providing the url and token
+     *
+     * @example
+     * ```typescript
+     * const index = new Index({
+     *  url: "<UPSTASH_VECTOR_REST_URL>",
+     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+     * });
+     * ```
+     * OR
+     * This will automatically get environment variables from .env file
+     * ```typescript
+     * const index = new Index();
+     * ```
+     */
+    constructor(config?: IndexConfig);
+    /**
+     * Create a new Upstash Vector instance from environment variables.
+     *
+     * Use this to automatically load connection secrets from your environment
+     * variables. For instance when using the Vercel integration.
+     *
+     * When used on the Cloudflare Workers, you can just pass the "env" context provided by Cloudflare.
+     * Else, this tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
+     * your environment using `process.env`.
+     */
+    static fromEnv(env?: {
+        UPSTASH_VECTOR_REST_URL: string;
+        UPSTASH_VECTOR_REST_TOKEN: string;
+    }, config?: Omit<IndexConfig, "url" | "token">): Index;
+}
+
+export { Index, type IndexConfig };

package/dist/cloudflare.d.ts

@@ -0,0 +1,60 @@
+import { R as RequesterConfig, D as Dict, I as Index$1 } from './vector-U-xfTq8V.js';
+export { F as FetchResult, d as InfoResult, Q as QueryResult, c as RangeResult, a as Requester, U as UpstashRequest, b as UpstashResponse, V as Vector } from './vector-U-xfTq8V.js';
+
+/**
+ * Connection credentials for upstash vector.
+ * Get them from https://console.upstash.com/vector/<uuid>
+ */
+type IndexConfig = {
+    /**
+     * UPSTASH_VECTOR_REST_URL
+     */
+    url?: string;
+    /**
+     * UPSTASH_VECTOR_REST_TOKEN
+     */
+    token?: string;
+    /**
+     * The signal will allow aborting requests on the fly.
+     * For more check: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+     */
+    signal?: AbortSignal;
+} & RequesterConfig;
+/**
+ * Serverless vector client for upstash.
+ */
+declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
+    /**
+     * Create a new vector client by providing the url and token
+     *
+     * @example
+     * ```typescript
+     * const index = new Index({
+     *  url: "<UPSTASH_VECTOR_REST_URL>",
+     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+     * });
+     * ```
+     * OR
+     * This will automatically get environment variables from .env file
+     * ```typescript
+     * const index = new Index();
+     * ```
+     */
+    constructor(config?: IndexConfig);
+    /**
+     * Create a new Upstash Vector instance from environment variables.
+     *
+     * Use this to automatically load connection secrets from your environment
+     * variables. For instance when using the Vercel integration.
+     *
+     * When used on the Cloudflare Workers, you can just pass the "env" context provided by Cloudflare.
+     * Else, this tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
+     * your environment using `process.env`.
+     */
+    static fromEnv(env?: {
+        UPSTASH_VECTOR_REST_URL: string;
+        UPSTASH_VECTOR_REST_TOKEN: string;
+    }, config?: Omit<IndexConfig, "url" | "token">): Index;
+}
+
+export { Index, type IndexConfig };

package/dist/cloudflare.js

@@ -0,0 +1 @@
+"use strict";var A=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var V=Object.getOwnPropertyNames;var N=Object.prototype.hasOwnProperty;var D=(n,e)=>{for(var t in e)A(n,t,{get:e[t],enumerable:!0})},O=(n,e,t,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of V(e))!N.call(n,s)&&s!==t&&A(n,s,{get:()=>e[s],enumerable:!(a=w(e,s))||a.enumerable});return n};var _=n=>O(A({},"__esModule",{value:!0}),n);var q={};D(q,{Index:()=>U});module.exports=_(q);var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var T=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,s=null;for(let g=0;g<=this.retry.attempts;g++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(S){if(this.options.signal?.aborted){let M=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),P={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(M,P);break}s=S,await new Promise(M=>setTimeout(M,this.retry.backoff(g)))}if(!a)throw s??new Error("Exhausted all retries");let o=await a.json();if(!a.ok)throw new i(`${o.error}`);return{result:o.result,error:o.error}}};var r=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends r{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let s=[];Array.isArray(e)?s.push(...e):s.push(e),super(s,a)}};var f=class extends r{constructor(e,t){let a="query";a=e.some(o=>o.data)?"query-data":"query",t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var d=class extends r{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends r{constructor(e,t){let a="upsert";Array.isArray(e)?a=e.some(o=>b(o))?"upsert":"upsert-data":a=b(e)?"upsert":"upsert-data",t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}},b=n=>"vector"in n;var c=class extends r{constructor([e,t]){let a="fetch";t?.namespace&&(a=`${a}/${t.namespace}`,delete t.namespace),super({ids:e,...t},a)}};var l=class extends r{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends r{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var C=class extends r{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);update=e=>new y(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>(e[1]?e[1].namespace=this.namespace:e[1]={namespace:this.namespace},new c(e).exec(this.client));query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var y=class extends r{constructor(e,t){let a="update";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var x=class extends r{constructor(){super([],"list-namespaces")}};var E=class extends r{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var R=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);queryMany=(e,t)=>new f(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);update=(e,t)=>new y(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new C().exec(this.client);listNamespaces=()=>new x().exec(this.client);deleteNamespace=e=>new E(e).exec(this.client)};var U=class n extends R{constructor(e){let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,a=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!a)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(a.startsWith(" ")||a.endsWith(" ")||/\r|\n/.test(a))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let s=new T({baseUrl:a,retry:e?.retry,headers:{authorization:`Bearer ${t}`},signal:e?.signal});super(s)}static fromEnv(e,t){let a,s;if(e){if(a=e.UPSTASH_VECTOR_REST_URL,!a)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`. Please add it via `wrangler secret put UPSTASH_VECTOR_REST_URL`");if(s=e.UPSTASH_VECTOR_REST_TOKEN,!s)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_VECTOR_REST_TOKEN`")}return new n({...t,url:a,token:s})}};0&&(module.exports={Index});

package/dist/cloudflare.mjs

@@ -0,0 +1 @@
+import{a as s,b as i}from"./chunk-EEOSY6EV.mjs";var o=class T extends i{constructor(t){let r=t?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,e=t?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!r)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!e)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(e.startsWith(" ")||e.endsWith(" ")||/\r|\n/.test(e))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(r.startsWith(" ")||r.endsWith(" ")||/\r|\n/.test(r))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let n=new s({baseUrl:e,retry:t?.retry,headers:{authorization:`Bearer ${r}`},signal:t?.signal});super(n)}static fromEnv(t,r){let e,n;if(t){if(e=t.UPSTASH_VECTOR_REST_URL,!e)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`. Please add it via `wrangler secret put UPSTASH_VECTOR_REST_URL`");if(n=t.UPSTASH_VECTOR_REST_TOKEN,!n)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_VECTOR_REST_TOKEN`")}return new T({...r,url:e,token:n})}};export{o as Index};

package/dist/nodejs.d.mts

@@ -0,0 +1,78 @@
+import { R as RequesterConfig, D as Dict, I as Index$1, a as Requester } from './vector-U-xfTq8V.mjs';
+export { F as FetchResult, d as InfoResult, Q as QueryResult, c as RangeResult, U as UpstashRequest, b as UpstashResponse, V as Vector } from './vector-U-xfTq8V.mjs';
+
+/**
+ * Connection credentials for upstash vector.
+ * Get them from https://console.upstash.com/vector/<uuid>
+ */
+type IndexConfig = {
+    /**
+     * UPSTASH_VECTOR_REST_URL
+     */
+    url?: string;
+    /**
+     * UPSTASH_VECTOR_REST_TOKEN
+     */
+    token?: string;
+    /**
+     * The signal will allow aborting requests on the fly.
+     * For more check: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+     */
+    signal?: AbortSignal;
+} & RequesterConfig;
+/**
+ * Serverless vector client for upstash.
+ */
+declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
+    /**
+     * Create a new vector client by providing the url and token
+     *
+     * @example
+     * ```typescript
+     * const index = new Index({
+     *  url: "<UPSTASH_VECTOR_REST_URL>",
+     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+     * });
+     * ```
+     * OR
+     * This will automatically get environment variables from .env file
+     * ```typescript
+     * const index = new Index();
+     * ```
+     */
+    constructor(config?: IndexConfig);
+    /**
+     * Create a new vector client by providing a custom `Requester` implementation
+     *
+     * @example
+     * ```ts
+     *
+     * import { UpstashRequest, Requester, UpstashResponse, vector } from "@upstash/vector"
+     *
+     *  const requester: Requester = {
+     *    request: <TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>> => {
+     *      // ...
+     *    }
+     *  }
+     *
+     * const vector = new vector(requester)
+     * ```
+     */
+    constructor(requesters?: Requester);
+    /**
+     * Create a new Upstash Vector instance from environment variables.
+     *
+     * Use this to automatically load connection secrets from your environment
+     * variables. For instance when using the Vercel integration.
+     *
+     * When used on the Cloudflare Workers, you can just pass the "env" context provided by Cloudflare.
+     * Else, this tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
+     * your environment using `process.env`.
+     */
+    static fromEnv(env?: {
+        UPSTASH_VECTOR_REST_URL: string;
+        UPSTASH_VECTOR_REST_TOKEN: string;
+    }, config?: Omit<IndexConfig, "url" | "token">): Index;
+}
+
+export { Index, type IndexConfig, Requester };

package/dist/nodejs.d.ts

@@ -0,0 +1,78 @@
+import { R as RequesterConfig, D as Dict, I as Index$1, a as Requester } from './vector-U-xfTq8V.js';
+export { F as FetchResult, d as InfoResult, Q as QueryResult, c as RangeResult, U as UpstashRequest, b as UpstashResponse, V as Vector } from './vector-U-xfTq8V.js';
+
+/**
+ * Connection credentials for upstash vector.
+ * Get them from https://console.upstash.com/vector/<uuid>
+ */
+type IndexConfig = {
+    /**
+     * UPSTASH_VECTOR_REST_URL
+     */
+    url?: string;
+    /**
+     * UPSTASH_VECTOR_REST_TOKEN
+     */
+    token?: string;
+    /**
+     * The signal will allow aborting requests on the fly.
+     * For more check: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+     */
+    signal?: AbortSignal;
+} & RequesterConfig;
+/**
+ * Serverless vector client for upstash.
+ */
+declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
+    /**
+     * Create a new vector client by providing the url and token
+     *
+     * @example
+     * ```typescript
+     * const index = new Index({
+     *  url: "<UPSTASH_VECTOR_REST_URL>",
+     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
+     * });
+     * ```
+     * OR
+     * This will automatically get environment variables from .env file
+     * ```typescript
+     * const index = new Index();
+     * ```
+     */
+    constructor(config?: IndexConfig);
+    /**
+     * Create a new vector client by providing a custom `Requester` implementation
+     *
+     * @example
+     * ```ts
+     *
+     * import { UpstashRequest, Requester, UpstashResponse, vector } from "@upstash/vector"
+     *
+     *  const requester: Requester = {
+     *    request: <TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>> => {
+     *      // ...
+     *    }
+     *  }
+     *
+     * const vector = new vector(requester)
+     * ```
+     */
+    constructor(requesters?: Requester);
+    /**
+     * Create a new Upstash Vector instance from environment variables.
+     *
+     * Use this to automatically load connection secrets from your environment
+     * variables. For instance when using the Vercel integration.
+     *
+     * When used on the Cloudflare Workers, you can just pass the "env" context provided by Cloudflare.
+     * Else, this tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
+     * your environment using `process.env`.
+     */
+    static fromEnv(env?: {
+        UPSTASH_VECTOR_REST_URL: string;
+        UPSTASH_VECTOR_REST_TOKEN: string;
+    }, config?: Omit<IndexConfig, "url" | "token">): Index;
+}
+
+export { Index, type IndexConfig, Requester };

package/dist/nodejs.js

@@ -0,0 +1 @@
+"use strict";var A=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var V=Object.getOwnPropertyNames;var N=Object.prototype.hasOwnProperty;var D=(n,e)=>{for(var t in e)A(n,t,{get:e[t],enumerable:!0})},_=(n,e,t,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of V(e))!N.call(n,s)&&s!==t&&A(n,s,{get:()=>e[s],enumerable:!(a=w(e,s))||a.enumerable});return n};var O=n=>_(A({},"__esModule",{value:!0}),n);var q={};D(q,{Index:()=>U});module.exports=O(q);var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var T=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,s=null;for(let g=0;g<=this.retry.attempts;g++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(S){if(this.options.signal?.aborted){let M=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),P={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(M,P);break}s=S,await new Promise(M=>setTimeout(M,this.retry.backoff(g)))}if(!a)throw s??new Error("Exhausted all retries");let o=await a.json();if(!a.ok)throw new i(`${o.error}`);return{result:o.result,error:o.error}}};var r=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends r{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let s=[];Array.isArray(e)?s.push(...e):s.push(e),super(s,a)}};var f=class extends r{constructor(e,t){let a="query";a=e.some(o=>o.data)?"query-data":"query",t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var d=class extends r{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends r{constructor(e,t){let a="upsert";Array.isArray(e)?a=e.some(o=>b(o))?"upsert":"upsert-data":a=b(e)?"upsert":"upsert-data",t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}},b=n=>"vector"in n;var c=class extends r{constructor([e,t]){let a="fetch";t?.namespace&&(a=`${a}/${t.namespace}`,delete t.namespace),super({ids:e,...t},a)}};var l=class extends r{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends r{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var C=class extends r{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);update=e=>new y(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>(e[1]?e[1].namespace=this.namespace:e[1]={namespace:this.namespace},new c(e).exec(this.client));query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var y=class extends r{constructor(e,t){let a="update";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var x=class extends r{constructor(){super([],"list-namespaces")}};var E=class extends r{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var R=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);queryMany=(e,t)=>new f(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);update=(e,t)=>new y(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new C().exec(this.client);listNamespaces=()=>new x().exec(this.client);deleteNamespace=e=>new E(e).exec(this.client)};var U=class n extends R{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,a=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!a)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(a.startsWith(" ")||a.endsWith(" ")||/\r|\n/.test(a))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let s=new T({baseUrl:a,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(s)}static fromEnv(e,t){let a=e?.UPSTASH_VECTOR_REST_URL||process?.env.UPSTASH_VECTOR_REST_URL,s=e?.UPSTASH_VECTOR_REST_TOKEN||process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!a)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");if(!s)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new n({...t,url:a,token:s})}};0&&(module.exports={Index});

package/dist/nodejs.mjs

@@ -0,0 +1 @@
+import{a as s,b as o}from"./chunk-EEOSY6EV.mjs";var T=class i extends o{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let n=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,t=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!n)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!t)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(n.startsWith(" ")||n.endsWith(" ")||/\r|\n/.test(n))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let r=new s({baseUrl:t,retry:e?.retry,headers:{authorization:`Bearer ${n}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(r)}static fromEnv(e,n){let t=e?.UPSTASH_VECTOR_REST_URL||process?.env.UPSTASH_VECTOR_REST_URL,r=e?.UPSTASH_VECTOR_REST_TOKEN||process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");if(!r)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new i({...n,url:t,token:r})}};export{T as Index};

package/dist/{index.d.mts → vector-U-xfTq8V.d.mts}

@@ -44,8 +44,9 @@ type RequesterConfig = {
 
 type Vector<TMetadata = Dict> = {
     id: string;
-    vector: number[];
+    vector?: number[];
     metadata?: TMetadata;
+    data?: string;
 };
 type NAMESPACE = string;
 type Dict = Record<string, unknown>;
@@ -78,6 +79,7 @@ type QueryCommandPayload = {
     filter?: string;
     includeVectors?: boolean;
     includeMetadata?: boolean;
+    includeData?: boolean;
 } & ({
     vector: number[];
     data?: never;
@@ -88,12 +90,18 @@ type QueryCommandPayload = {
 type QueryResult<TMetadata = Dict> = {
     id: number | string;
     score: number;
-    vector: number[];
+    vector?: number[];
     metadata?: TMetadata;
+    data?: string;
 };
 type QueryCommandOptions = {
     namespace?: string;
 };
+
+declare class QueryManyCommand<TMetadata> extends Command<QueryResult<TMetadata>[][]> {
+    constructor(payload: QueryCommandPayload[], options?: QueryCommandOptions);
+}
+
 declare class QueryCommand<TMetadata> extends Command<QueryResult<TMetadata>[]> {
     constructor(payload: QueryCommandPayload, options?: QueryCommandOptions);
 }
@@ -196,6 +204,7 @@ declare class Namespace<TIndexMetadata extends Dict = Dict> {
     } | {
         id: string | number;
         metadata: TMetadata extends infer U ? U : never;
+        metadataUpdateMode?: "PATCH" | "OVERWRITE" | undefined;
     }) => Promise<{
         updated: number;
     }>;
@@ -223,6 +232,7 @@ declare class Namespace<TIndexMetadata extends Dict = Dict> {
     fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
+        includeData?: boolean | undefined;
         namespace?: string | undefined;
     } | undefined) => Promise<FetchResult<TMetadata>[]>;
     /**
@@ -305,7 +315,7 @@ type CommandArgs<TCommand extends new (_args: any) => any> = ConstructorParamete
 /**
  * Serverless vector client for upstash vector db.
  */
-declare class Index$1<TIndexMetadata extends Dict = Dict> {
+declare class Index<TIndexMetadata extends Dict = Dict> {
     protected client: Requester;
     /**
      * Create a new vector db client
@@ -356,12 +366,49 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
      * @param {string} [args.filter] - An optional filter string to be used in the query. The filter string is used to narrow down the query results.
      * @param {boolean} [args.includeVectors=false] - When set to true, includes the feature vectors of the returned items in the response.
      * @param {boolean} [args.includeMetadata=false] - When set to true, includes additional metadata of the returned items in the response.
+     * @param {boolean} [args.includeData=false] - When set to true, includes data - string - of the returned items in the response.
      *
-     * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
+     *  A promise that resolves with an array of query result objects when the request to query the index is completed.
      */
     query: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>, options?: {
         namespace?: string;
     }) => Promise<QueryResult<TMetadata>[]>;
+    /**
+     * Queries an index with specified parameters.
+     * This method creates and executes a query command on an index based on the provided arguments.
+     *
+     * @example
+     * ```js
+     * await index.queryMany([
+     * {
+     *     topK: 3,
+     *     vector: [0.22, 0.66],
+     *     filter: "age >= 23 and (type = 'turtle' OR type = 'cat')",
+     * },
+     * {
+     *     topK: 3,
+     *     vector: [0.45, 0.52],
+     *     filter: "age >= 27 and (type = 'rabbit' OR type = 'dog')",
+     * },
+     * ]);
+     *
+     * ```
+     *
+     * @param {Object} args - The arguments for the query command.
+     * @param {number[]} args.vector - An array of numbers representing the feature vector for the query.
+     *                                This vector is utilized to find the most relevant items in the index.
+     * @param {number} args.topK - The desired number of top results to be returned, based on relevance or similarity to the query vector.
+     * @param {string} [args.filter] - An optional filter string to be used in the query. The filter string is used to narrow down the query results.
+     * @param {boolean} [args.includeVectors=false] - When set to true, includes the feature vectors of the returned items in the response.
+     * @param {boolean} [args.includeMetadata=false] - When set to true, includes additional metadata of the returned items in the response.
+     * @param {boolean} [args.includeData=false] - When set to true, includes data - string - of the returned items in the response.
+     *
+     *  A promise that resolves with an array of arrays of query result objects,
+     *  where each inner array represents a group of results matching a specific query condition.
+     */
+    queryMany: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryManyCommand>, options?: {
+        namespace?: string;
+    }) => Promise<QueryResult<TMetadata>[][]>;
     /**
      * Upserts (Updates and Inserts) specific items into the index.
      * It's used for adding new items to the index or updating existing ones.
@@ -412,6 +459,7 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
     } | {
         id: string | number;
         metadata: TMetadata extends infer U ? U : never;
+        metadataUpdateMode?: "PATCH" | "OVERWRITE" | undefined;
     }, options?: {
         namespace?: string;
     }) => Promise<{
@@ -430,16 +478,18 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
      * ```
      *
      * @param {...CommandArgs<typeof FetchCommand>} args - The arguments for the fetch command.
-     * @param {(number[]|string[])} args[0] - An array of IDs of the items to be fetched.
-     * @param {FetchCommandOptions} args[1] - Options for the fetch operation.
-     * @param {boolean} [args[1].includeMetadata=false] - Optionally include metadata of the fetched items.
-     * @param {boolean} [args[1].includeVectors=false] - Optionally include feature vectors of the fetched items.
+     * @param {(number[]|string[])} args - An array of IDs of the items to be fetched.
+     * @param {FetchCommandOptions} args - Options for the fetch operation.
+     * @param {boolean} [args.includeMetadata=false] - Optionally include metadata of the fetched items.
+     * @param {boolean} [args.includeVectors=false] - Optionally include feature vectors of the fetched items.
+     * @param {boolean} [args.metadataUpdateMode="OVERWRITE"] - Specifies whether to overwrite or patch the metadata values.
      *
      * @returns {Promise<FetchReturnResponse<TMetadata>[]>} A promise that resolves with an array of fetched items or null if not found, after the command is executed.
      */
     fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
+        includeData?: boolean | undefined;
         namespace?: string | undefined;
     } | undefined) => Promise<FetchResult<TMetadata>[]>;
     /**
@@ -521,74 +571,4 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
     deleteNamespace: (namespace: string) => Promise<string>;
 }
 
-/**
- * Connection credentials for upstash vector.
- * Get them from https://console.upstash.com/vector/<uuid>
- */
-type IndexConfig = {
-    /**
-     * UPSTASH_VECTOR_REST_URL
-     */
-    url?: string;
-    /**
-     * UPSTASH_VECTOR_REST_TOKEN
-     */
-    token?: string;
-    /**
-     * The signal will allow aborting requests on the fly.
-     * For more check: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
-     */
-    signal?: AbortSignal;
-} & RequesterConfig;
-/**
- * Serverless vector client for upstash.
- */
-declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
-    /**
-     * Create a new vector client by providing the url and token
-     *
-     * @example
-     * ```typescript
-     * const index = new Index({
-     *  url: "<UPSTASH_VECTOR_REST_URL>",
-     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
-     * });
-     * ```
-     * OR
-     * This will automatically get environment variables from .env file
-     * ```typescript
-     * const index = new Index();
-     * ```
-     */
-    constructor(config?: IndexConfig);
-    /**
-     * Create a new vector client by providing a custom `Requester` implementation
-     *
-     * @example
-     * ```ts
-     *
-     * import { UpstashRequest, Requester, UpstashResponse, vector } from "@upstash/vector"
-     *
-     *  const requester: Requester = {
-     *    request: <TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>> => {
-     *      // ...
-     *    }
-     *  }
-     *
-     * const vector = new vector(requester)
-     * ```
-     */
-    constructor(requesters?: Requester);
-    /**
-     * Create a new Upstash Vector instance from environment variables.
-     *
-     * Use this to automatically load connection secrets from your environment
-     * variables. For instance when using the Vercel integration.
-     *
-     * This tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
-     * your environment using `process.env`.
-     */
-    static fromEnv(config?: Omit<IndexConfig, "url" | "token">): Index;
-}
-
-export { type FetchResult, Index, type IndexConfig, type InfoResult, type QueryResult, type RangeResult, type Requester, type UpstashRequest, type UpstashResponse, type Vector };
+export { type Dict as D, type FetchResult as F, Index as I, type QueryResult as Q, type RequesterConfig as R, type UpstashRequest as U, type Vector as V, type Requester as a, type UpstashResponse as b, type RangeResult as c, type InfoResult as d };

package/dist/{index.d.ts → vector-U-xfTq8V.d.ts}

@@ -44,8 +44,9 @@ type RequesterConfig = {
 
 type Vector<TMetadata = Dict> = {
     id: string;
-    vector: number[];
+    vector?: number[];
     metadata?: TMetadata;
+    data?: string;
 };
 type NAMESPACE = string;
 type Dict = Record<string, unknown>;
@@ -78,6 +79,7 @@ type QueryCommandPayload = {
     filter?: string;
     includeVectors?: boolean;
     includeMetadata?: boolean;
+    includeData?: boolean;
 } & ({
     vector: number[];
     data?: never;
@@ -88,12 +90,18 @@ type QueryCommandPayload = {
 type QueryResult<TMetadata = Dict> = {
     id: number | string;
     score: number;
-    vector: number[];
+    vector?: number[];
     metadata?: TMetadata;
+    data?: string;
 };
 type QueryCommandOptions = {
     namespace?: string;
 };
+
+declare class QueryManyCommand<TMetadata> extends Command<QueryResult<TMetadata>[][]> {
+    constructor(payload: QueryCommandPayload[], options?: QueryCommandOptions);
+}
+
 declare class QueryCommand<TMetadata> extends Command<QueryResult<TMetadata>[]> {
     constructor(payload: QueryCommandPayload, options?: QueryCommandOptions);
 }
@@ -196,6 +204,7 @@ declare class Namespace<TIndexMetadata extends Dict = Dict> {
     } | {
         id: string | number;
         metadata: TMetadata extends infer U ? U : never;
+        metadataUpdateMode?: "PATCH" | "OVERWRITE" | undefined;
     }) => Promise<{
         updated: number;
     }>;
@@ -223,6 +232,7 @@ declare class Namespace<TIndexMetadata extends Dict = Dict> {
     fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
+        includeData?: boolean | undefined;
         namespace?: string | undefined;
     } | undefined) => Promise<FetchResult<TMetadata>[]>;
     /**
@@ -305,7 +315,7 @@ type CommandArgs<TCommand extends new (_args: any) => any> = ConstructorParamete
 /**
  * Serverless vector client for upstash vector db.
  */
-declare class Index$1<TIndexMetadata extends Dict = Dict> {
+declare class Index<TIndexMetadata extends Dict = Dict> {
     protected client: Requester;
     /**
      * Create a new vector db client
@@ -356,12 +366,49 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
      * @param {string} [args.filter] - An optional filter string to be used in the query. The filter string is used to narrow down the query results.
      * @param {boolean} [args.includeVectors=false] - When set to true, includes the feature vectors of the returned items in the response.
      * @param {boolean} [args.includeMetadata=false] - When set to true, includes additional metadata of the returned items in the response.
+     * @param {boolean} [args.includeData=false] - When set to true, includes data - string - of the returned items in the response.
      *
-     * @returns A promise that resolves with an array of query result objects when the request to query the index is completed.
+     *  A promise that resolves with an array of query result objects when the request to query the index is completed.
      */
     query: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryCommand>, options?: {
         namespace?: string;
     }) => Promise<QueryResult<TMetadata>[]>;
+    /**
+     * Queries an index with specified parameters.
+     * This method creates and executes a query command on an index based on the provided arguments.
+     *
+     * @example
+     * ```js
+     * await index.queryMany([
+     * {
+     *     topK: 3,
+     *     vector: [0.22, 0.66],
+     *     filter: "age >= 23 and (type = 'turtle' OR type = 'cat')",
+     * },
+     * {
+     *     topK: 3,
+     *     vector: [0.45, 0.52],
+     *     filter: "age >= 27 and (type = 'rabbit' OR type = 'dog')",
+     * },
+     * ]);
+     *
+     * ```
+     *
+     * @param {Object} args - The arguments for the query command.
+     * @param {number[]} args.vector - An array of numbers representing the feature vector for the query.
+     *                                This vector is utilized to find the most relevant items in the index.
+     * @param {number} args.topK - The desired number of top results to be returned, based on relevance or similarity to the query vector.
+     * @param {string} [args.filter] - An optional filter string to be used in the query. The filter string is used to narrow down the query results.
+     * @param {boolean} [args.includeVectors=false] - When set to true, includes the feature vectors of the returned items in the response.
+     * @param {boolean} [args.includeMetadata=false] - When set to true, includes additional metadata of the returned items in the response.
+     * @param {boolean} [args.includeData=false] - When set to true, includes data - string - of the returned items in the response.
+     *
+     *  A promise that resolves with an array of arrays of query result objects,
+     *  where each inner array represents a group of results matching a specific query condition.
+     */
+    queryMany: <TMetadata extends Dict = TIndexMetadata>(args: CommandArgs<typeof QueryManyCommand>, options?: {
+        namespace?: string;
+    }) => Promise<QueryResult<TMetadata>[][]>;
     /**
      * Upserts (Updates and Inserts) specific items into the index.
      * It's used for adding new items to the index or updating existing ones.
@@ -412,6 +459,7 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
     } | {
         id: string | number;
         metadata: TMetadata extends infer U ? U : never;
+        metadataUpdateMode?: "PATCH" | "OVERWRITE" | undefined;
     }, options?: {
         namespace?: string;
     }) => Promise<{
@@ -430,16 +478,18 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
      * ```
      *
      * @param {...CommandArgs<typeof FetchCommand>} args - The arguments for the fetch command.
-     * @param {(number[]|string[])} args[0] - An array of IDs of the items to be fetched.
-     * @param {FetchCommandOptions} args[1] - Options for the fetch operation.
-     * @param {boolean} [args[1].includeMetadata=false] - Optionally include metadata of the fetched items.
-     * @param {boolean} [args[1].includeVectors=false] - Optionally include feature vectors of the fetched items.
+     * @param {(number[]|string[])} args - An array of IDs of the items to be fetched.
+     * @param {FetchCommandOptions} args - Options for the fetch operation.
+     * @param {boolean} [args.includeMetadata=false] - Optionally include metadata of the fetched items.
+     * @param {boolean} [args.includeVectors=false] - Optionally include feature vectors of the fetched items.
+     * @param {boolean} [args.metadataUpdateMode="OVERWRITE"] - Specifies whether to overwrite or patch the metadata values.
      *
      * @returns {Promise<FetchReturnResponse<TMetadata>[]>} A promise that resolves with an array of fetched items or null if not found, after the command is executed.
      */
     fetch: <TMetadata extends Dict = TIndexMetadata>(ids: number[] | string[], opts?: {
         includeMetadata?: boolean | undefined;
         includeVectors?: boolean | undefined;
+        includeData?: boolean | undefined;
         namespace?: string | undefined;
     } | undefined) => Promise<FetchResult<TMetadata>[]>;
     /**
@@ -521,74 +571,4 @@ declare class Index$1<TIndexMetadata extends Dict = Dict> {
     deleteNamespace: (namespace: string) => Promise<string>;
 }
 
-/**
- * Connection credentials for upstash vector.
- * Get them from https://console.upstash.com/vector/<uuid>
- */
-type IndexConfig = {
-    /**
-     * UPSTASH_VECTOR_REST_URL
-     */
-    url?: string;
-    /**
-     * UPSTASH_VECTOR_REST_TOKEN
-     */
-    token?: string;
-    /**
-     * The signal will allow aborting requests on the fly.
-     * For more check: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
-     */
-    signal?: AbortSignal;
-} & RequesterConfig;
-/**
- * Serverless vector client for upstash.
- */
-declare class Index<TIndexMetadata extends Dict = Dict> extends Index$1<TIndexMetadata> {
-    /**
-     * Create a new vector client by providing the url and token
-     *
-     * @example
-     * ```typescript
-     * const index = new Index({
-     *  url: "<UPSTASH_VECTOR_REST_URL>",
-     *  token: "<UPSTASH_VECTOR_REST_TOKEN>",
-     * });
-     * ```
-     * OR
-     * This will automatically get environment variables from .env file
-     * ```typescript
-     * const index = new Index();
-     * ```
-     */
-    constructor(config?: IndexConfig);
-    /**
-     * Create a new vector client by providing a custom `Requester` implementation
-     *
-     * @example
-     * ```ts
-     *
-     * import { UpstashRequest, Requester, UpstashResponse, vector } from "@upstash/vector"
-     *
-     *  const requester: Requester = {
-     *    request: <TResult>(req: UpstashRequest): Promise<UpstashResponse<TResult>> => {
-     *      // ...
-     *    }
-     *  }
-     *
-     * const vector = new vector(requester)
-     * ```
-     */
-    constructor(requesters?: Requester);
-    /**
-     * Create a new Upstash Vector instance from environment variables.
-     *
-     * Use this to automatically load connection secrets from your environment
-     * variables. For instance when using the Vercel integration.
-     *
-     * This tries to load `UPSTASH_VECTOR_REST_URL` and `UPSTASH_VECTOR_REST_TOKEN` from
-     * your environment using `process.env`.
-     */
-    static fromEnv(config?: Omit<IndexConfig, "url" | "token">): Index;
-}
-
-export { type FetchResult, Index, type IndexConfig, type InfoResult, type QueryResult, type RangeResult, type Requester, type UpstashRequest, type UpstashResponse, type Vector };
+export { type Dict as D, type FetchResult as F, Index as I, type QueryResult as Q, type RequesterConfig as R, type UpstashRequest as U, type Vector as V, type Requester as a, type UpstashResponse as b, type RangeResult as c, type InfoResult as d };

package/package.json

@@ -1 +1 @@
-{ "name": "@upstash/vector", "version": "v1.1.2", "author": "Oguzhan Olguncu <oguzhan@upstash.com>", "repository": { "type": "git", "url": "https://github.com/upstash/vector-js" }, "main": "./dist/index.js", "module": "./dist/index.mjs", "devDependencies": { "@biomejs/biome": "^1.4.1", "@commitlint/cli": "^18.6.0", "@commitlint/config-conventional": "^18.6.0", "bun-types": "latest", "husky": "^8.0.3", "tsup": "latest", "typescript": "^5.0.0", "vitest": "^1.2.2" }, "bugs": { "url": "https://github.com/upstash/vector/issues" }, "description": "An HTTP/REST based Vector DB client built on top of Upstash REST API.", "files": [ "dist" ], "homepage": "https://upstash.com/vector", "keywords": [ "vector", "upstash", "db" ], "license": "MIT", "scripts": { "test": "bun test src --coverage --bail --coverageSkipTestFiles=[test-utils.ts] --timeout 20000 && vitest run --typecheck", "fmt": "bunx biome check --apply ./src", "build": "tsup", "prepare": "husky install" }, "types": "./dist/index.d.ts" }
+{ "name": "@upstash/vector", "version": "v1.1.3-canary", "author": "Oguzhan Olguncu <oguzhan@upstash.com>", "repository": { "type": "git", "url": "https://github.com/upstash/vector-js" }, "exports": { ".": { "import": "./dist/nodejs.mjs", "require": "./dist/nodejs.js", "types": "./dist/nodejs.d.ts", "browser": "./dist/nodejs.mjs", "bun": "./dist/nodejs.mjs", "deno": "./dist/nodejs.mjs", "edge-light": "./dist/nodejs.mjs", "edge-routine": "./dist/nodejs.mjs", "netlify": "./dist/nodejs.mjs", "react-native": "./dist/nodejs.mjs", "wintercg": "./dist/nodejs.mjs", "worker": { "import": "./dist/cloudflare.mjs", "types": "./dist/cloudflare.d.ts" }, "workerd": { "import": "./dist/cloudflare.mjs", "types": "./dist/cloudflare.d.ts" } } }, "main": "./dist/nodejs.js", "module": "./dist/nodejs.mjs", "browser": "./dist/nodejs.mjs", "types": "./dist/nodejs.d.ts", "devDependencies": { "@biomejs/biome": "^1.4.1", "@commitlint/cli": "^18.6.0", "@commitlint/config-conventional": "^18.6.0", "bun-types": "latest", "husky": "^8.0.3", "tsup": "latest", "typescript": "^5.0.0", "vitest": "^1.2.2" }, "bugs": { "url": "https://github.com/upstash/vector/issues" }, "description": "An HTTP/REST based Vector DB client built on top of Upstash REST API.", "files": [ "dist" ], "homepage": "https://upstash.com/vector", "keywords": [ "vector", "upstash", "db" ], "license": "MIT", "scripts": { "test": "bun test src --coverage --bail --coverageSkipTestFiles=[test-utils.ts] --timeout 20000 && vitest run --typecheck", "fmt": "bunx biome check --apply ./src", "build": "tsup", "prepare": "husky install" } }

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";var R=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var P=Object.getOwnPropertyNames;var w=Object.prototype.hasOwnProperty;var N=(n,e)=>{for(var t in e)R(n,t,{get:e[t],enumerable:!0})},D=(n,e,t,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of P(e))!w.call(n,s)&&s!==t&&R(n,s,{get:()=>e[s],enumerable:!(a=S(e,s))||a.enumerable});return n};var V=n=>D(R({},"__esModule",{value:!0}),n);var _={};N(_,{Index:()=>b});module.exports=V(_);var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var f=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,s=null;for(let g=0;g<=this.retry.attempts;g++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(A){if(this.options.signal?.aborted){let M=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),U={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(M,U);break}s=A,await new Promise(M=>setTimeout(M,this.retry.backoff(g)))}if(!a)throw s??new Error("Exhausted all retries");let o=await a.json();if(!a.ok)throw new i(`${o.error}`);return{result:o.result,error:o.error}}};var r=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends r{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let s=[];Array.isArray(e)?s.push(...e):s.push(e),super(s,a)}};var d=class extends r{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends r{constructor(e,t){let a="upsert";if(Array.isArray(e)){if(e.some(o=>"data"in o&&o.data)){a="upsert-data";for(let o of e)!("metadata"in o)&&"data"in o&&(o.metadata={data:o.data})}}else"data"in e&&(a="upsert-data","metadata"in e||(e.metadata={data:e.data}));t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var c=class extends r{constructor([e,t]){let a="fetch";t?.namespace&&(a=`${a}/${t.namespace}`,delete t.namespace),super({ids:e,...t},a)}};var l=class extends r{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends r{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var T=class extends r{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);update=e=>new y(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>(e[1]?e[1].namespace=this.namespace:e[1]={namespace:this.namespace},new c(e).exec(this.client));query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var y=class extends r{constructor(e,t){let a="update";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var C=class extends r{constructor(){super([],"list-namespaces")}};var x=class extends r{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var E=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);update=(e,t)=>new y(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new T().exec(this.client);listNamespaces=()=>new C().exec(this.client);deleteNamespace=e=>new x(e).exec(this.client)};var b=class n extends E{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,a=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!a)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(a.startsWith(" ")||a.endsWith(" ")||/\r|\n/.test(a))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let s=new f({baseUrl:a,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(s)}static fromEnv(e){let t=process?.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");let a=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!a)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new n({...e,url:t,token:a})}};0&&(module.exports={Index});

package/dist/index.mjs

@@ -1 +0,0 @@
-var i=class extends Error{constructor(e){super(e),this.name="UpstashError"}};var f=class{baseUrl;headers;options;retry;constructor(e){this.options={cache:e.cache,signal:e.signal},this.baseUrl=e.baseUrl.replace(/\/$/,""),this.headers={"Content-Type":"application/json",...e.headers},typeof e?.retry=="boolean"&&e?.retry===!1?this.retry={attempts:1,backoff:()=>0}:this.retry={attempts:e?.retry?.retries??5,backoff:e?.retry?.backoff??(t=>Math.exp(t)*50)}}async request(e){let t={cache:this.options.cache,method:"POST",headers:this.headers,body:JSON.stringify(e.body),keepalive:!0,signal:this.options.signal},a=null,o=null;for(let g=0;g<=this.retry.attempts;g++)try{a=await fetch([this.baseUrl,...e.path??[]].join("/"),t);break}catch(b){if(this.options.signal?.aborted){let M=new Blob([JSON.stringify({result:this.options.signal.reason??"Aborted"})]),A={status:200,statusText:this.options.signal.reason??"Aborted"};a=new Response(M,A);break}o=b,await new Promise(M=>setTimeout(M,this.retry.backoff(g)))}if(!a)throw o??new Error("Exhausted all retries");let s=await a.json();if(!a.ok)throw new i(`${s.error}`);return{result:s.result,error:s.error}}};var n=class{payload;endpoint;constructor(e,t){this.payload=e,this.endpoint=t}async exec(e){let{result:t,error:a}=await e.request({body:this.payload,path:[this.endpoint]});if(a)throw new i(a);if(typeof t>"u")throw new Error("Request did not return a result");return t}};var p=class extends n{constructor(e,t){let a="delete";t?.namespace&&(a=`${a}/${t.namespace}`);let o=[];Array.isArray(e)?o.push(...e):o.push(e),super(o,a)}};var d=class extends n{constructor(e,t){let a="query";"data"in e&&(a="query-data"),t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var m=class extends n{constructor(e,t){let a="upsert";if(Array.isArray(e)){if(e.some(s=>"data"in s&&s.data)){a="upsert-data";for(let s of e)!("metadata"in s)&&"data"in s&&(s.metadata={data:s.data})}}else"data"in e&&(a="upsert-data","metadata"in e||(e.metadata={data:e.data}));t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var c=class extends n{constructor([e,t]){let a="fetch";t?.namespace&&(a=`${a}/${t.namespace}`,delete t.namespace),super({ids:e,...t},a)}};var l=class extends n{constructor(e,t){let a="range";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var u=class extends n{constructor(e){let t="reset";e?.namespace&&(t=`${t}/${e.namespace}`),super([],t)}};var T=class extends n{constructor(){super([],"info")}};var h=class{client;namespace;constructor(e,t){this.client=e,this.namespace=t}upsert=e=>new m(e,{namespace:this.namespace}).exec(this.client);update=e=>new y(e,{namespace:this.namespace}).exec(this.client);fetch=(...e)=>(e[1]?e[1].namespace=this.namespace:e[1]={namespace:this.namespace},new c(e).exec(this.client));query=e=>new d(e,{namespace:this.namespace}).exec(this.client);delete=e=>new p(e,{namespace:this.namespace}).exec(this.client);range=e=>new l(e,{namespace:this.namespace}).exec(this.client);reset=()=>new u({namespace:this.namespace}).exec(this.client)};var y=class extends n{constructor(e,t){let a="update";t?.namespace&&(a=`${a}/${t.namespace}`),super(e,a)}};var C=class extends n{constructor(){super([],"list-namespaces")}};var x=class extends n{constructor(e){let t=`delete-namespace/${e}`;super([],t)}};var E=class{client;constructor(e){this.client=e}namespace=e=>new h(this.client,e);delete=(e,t)=>new p(e,t).exec(this.client);query=(e,t)=>new d(e,t).exec(this.client);upsert=(e,t)=>new m(e,t).exec(this.client);update=(e,t)=>new y(e,t).exec(this.client);fetch=(...e)=>new c(e).exec(this.client);reset=e=>new u(e).exec(this.client);range=(e,t)=>new l(e,t).exec(this.client);info=()=>new T().exec(this.client);listNamespaces=()=>new C().exec(this.client);deleteNamespace=e=>new x(e).exec(this.client)};var R=class r extends E{constructor(e){if(typeof e<"u"&&"request"in e){super(e);return}let t=e?.token??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_TOKEN??process.env.UPSTASH_VECTOR_REST_TOKEN,a=e?.url??process.env.NEXT_PUBLIC_UPSTASH_VECTOR_REST_URL??process.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("UPSTASH_VECTOR_REST_TOKEN is missing!");if(!a)throw new Error("UPSTASH_VECTOR_REST_URL is missing!");(a.startsWith(" ")||a.endsWith(" ")||/\r|\n/.test(a))&&console.warn("The vector url contains whitespace or newline, which can cause errors!"),(t.startsWith(" ")||t.endsWith(" ")||/\r|\n/.test(t))&&console.warn("The vector token contains whitespace or newline, which can cause errors!");let o=new f({baseUrl:a,retry:e?.retry,headers:{authorization:`Bearer ${t}`},cache:e?.cache===!1?void 0:e?.cache||"no-store",signal:e?.signal});super(o)}static fromEnv(e){let t=process?.env.UPSTASH_VECTOR_REST_URL;if(!t)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_URL`");let a=process?.env.UPSTASH_VECTOR_REST_TOKEN;if(!a)throw new Error("Unable to find environment variable: `UPSTASH_VECTOR_REST_TOKEN`");return new r({...e,url:t,token:a})}};export{R as Index};