@aws-sdk/client-s3vectors 3.1069.0 → 3.1070.0

package/dist-cjs/index.js

@@ -343,6 +343,8 @@ const paginateListVectorBuckets = createPaginator(S3VectorsClient, ListVectorBuc
 
 const paginateListVectors = createPaginator(S3VectorsClient, ListVectorsCommand, "nextToken", "nextToken", "maxResults");
 
+const paginateQueryVectors = createPaginator(S3VectorsClient, QueryVectorsCommand, "nextToken", "nextToken", "");
+
 const commands = {
     CreateIndexCommand,
     CreateVectorBucketCommand,
@@ -368,6 +370,7 @@ const paginators = {
     paginateListIndexes,
     paginateListVectorBuckets,
     paginateListVectors,
+    paginateQueryVectors,
 };
 class S3Vectors extends S3VectorsClient {
 }
@@ -412,3 +415,4 @@ exports.UntagResourceCommand = UntagResourceCommand;
 exports.paginateListIndexes = paginateListIndexes;
 exports.paginateListVectorBuckets = paginateListVectorBuckets;
 exports.paginateListVectors = paginateListVectors;
+exports.paginateQueryVectors = paginateQueryVectors;

package/dist-cjs/schemas/schemas_0.js

@@ -482,14 +482,14 @@ const QueryOutputVector$ = [3, n0, _QOV,
 exports.QueryOutputVector$ = QueryOutputVector$;
 const QueryVectorsInput$ = [3, n0, _QVI,
     0,
-    [_tK, _qV, _vBN, _iN, _iA, _f, _rM, _rDe],
-    [1, () => VectorData$, 0, 0, 0, 15, 2, 2], 2
+    [_tK, _qV, _vBN, _iN, _iA, _f, _rM, _rDe, _nT],
+    [1, () => VectorData$, 0, 0, 0, 15, 2, 2, 0], 2
 ];
 exports.QueryVectorsInput$ = QueryVectorsInput$;
 const QueryVectorsOutput$ = [3, n0, _QVO,
     0,
-    [_v, _dM],
-    [() => QueryVectorsOutputList, 0], 2
+    [_v, _dM, _nT],
+    [() => QueryVectorsOutputList, 0, 0], 2
 ];
 exports.QueryVectorsOutput$ = QueryVectorsOutput$;
 const TagResourceInput$ = [3, n0, _TRI,

package/dist-es/S3Vectors.js

@@ -21,6 +21,7 @@ import { UntagResourceCommand, } from "./commands/UntagResourceCommand";
 import { paginateListIndexes } from "./pagination/ListIndexesPaginator";
 import { paginateListVectorBuckets } from "./pagination/ListVectorBucketsPaginator";
 import { paginateListVectors } from "./pagination/ListVectorsPaginator";
+import { paginateQueryVectors } from "./pagination/QueryVectorsPaginator";
 import { S3VectorsClient } from "./S3VectorsClient";
 const commands = {
     CreateIndexCommand,
@@ -47,6 +48,7 @@ const paginators = {
     paginateListIndexes,
     paginateListVectorBuckets,
     paginateListVectors,
+    paginateQueryVectors,
 };
 export class S3Vectors extends S3VectorsClient {
 }

package/dist-es/pagination/QueryVectorsPaginator.js

@@ -0,0 +1,4 @@
+import { createPaginator } from "@smithy/core";
+import { QueryVectorsCommand, } from "../commands/QueryVectorsCommand";
+import { S3VectorsClient } from "../S3VectorsClient";
+export const paginateQueryVectors = createPaginator(S3VectorsClient, QueryVectorsCommand, "nextToken", "nextToken", "");

package/dist-es/pagination/index.js

@@ -2,3 +2,4 @@ export * from "./Interfaces";
 export * from "./ListIndexesPaginator";
 export * from "./ListVectorBucketsPaginator";
 export * from "./ListVectorsPaginator";
+export * from "./QueryVectorsPaginator";

package/dist-es/schemas/schemas_0.js

@@ -428,13 +428,13 @@ export var QueryOutputVector$ = [3, n0, _QOV,
 ];
 export var QueryVectorsInput$ = [3, n0, _QVI,
     0,
-    [_tK, _qV, _vBN, _iN, _iA, _f, _rM, _rDe],
-    [1, () => VectorData$, 0, 0, 0, 15, 2, 2], 2
+    [_tK, _qV, _vBN, _iN, _iA, _f, _rM, _rDe, _nT],
+    [1, () => VectorData$, 0, 0, 0, 15, 2, 2, 0], 2
 ];
 export var QueryVectorsOutput$ = [3, n0, _QVO,
     0,
-    [_v, _dM],
-    [() => QueryVectorsOutputList, 0], 2
+    [_v, _dM, _nT],
+    [() => QueryVectorsOutputList, 0, 0], 2
 ];
 export var TagResourceInput$ = [3, n0, _TRI,
     0,

package/dist-types/S3Vectors.d.ts

@@ -164,6 +164,13 @@ export interface S3Vectors {
      * @returns AsyncIterable of {@link ListVectorsCommandOutput}.
      */
     paginateListVectors(args?: ListVectorsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<ListVectorsCommandOutput>;
+    /**
+     * @see {@link QueryVectorsCommand}
+     * @param args - command input.
+     * @param paginationConfig - optional pagination config.
+     * @returns AsyncIterable of {@link QueryVectorsCommandOutput}.
+     */
+    paginateQueryVectors(args: QueryVectorsCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<QueryVectorsCommandOutput>;
 }
 /**
  * <p>Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for you to interact with vectors to do similarity search. Within a vector bucket, you use a vector index to organize and logically group your vector data. When you make a write or read request, you direct it to a single vector index. You store your vector data as vectors. A vector contains a key (a name that you assign), a multi-dimensional vector, and, optionally, metadata that describes a vector. The key uniquely identifies the vector in a vector index.</p>

package/dist-types/commands/QueryVectorsCommand.d.ts

@@ -29,7 +29,7 @@ declare const QueryVectorsCommand_base: {
     };
 };
 /**
- * <p>Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response), the vector data, and metadata of each vector in the response. </p> <p>To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:QueryVectors</code> permission to use this operation. Additional permissions are required based on the request parameters you specify:</p> <ul> <li> <p>With only <code>s3vectors:QueryVectors</code> permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request vector data or metadata (by keeping the <code>returnMetadata</code> parameter set to <code>false</code> or not specified).</p> </li> <li> <p>If you specify a metadata filter or set <code>returnMetadata</code> to true, you must have both <code>s3vectors:QueryVectors</code> and <code>s3vectors:GetVectors</code> permissions. The request fails with a <code>403 Forbidden error</code> if you request metadata filtering, vector data, or metadata without the <code>s3vectors:GetVectors</code> permission.</p> </li> </ul> </dd> </dl>
+ * <p>Performs an approximate nearest neighbor search query in a vector index using a query vector. By default, it returns the keys of approximate nearest neighbors. You can optionally include the computed distance (between the query vector and each vector in the response) and metadata of each vector in the response.</p> <p>To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN). </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3vectors:QueryVectors</code> permission to use this operation. Additional permissions are required based on the request parameters you specify:</p> <ul> <li> <p>With only <code>s3vectors:QueryVectors</code> permission, you can retrieve vector keys of approximate nearest neighbors and computed distances between these vectors. This permission is sufficient only when you don't set any metadata filters and don't request metadata (by keeping the <code>returnMetadata</code> parameter set to <code>false</code> or not specified).</p> </li> <li> <p>If you specify a metadata filter or set <code>returnMetadata</code> to true, you must have both <code>s3vectors:QueryVectors</code> and <code>s3vectors:GetVectors</code> permissions. The request fails with a <code>403 Forbidden error</code> if you request metadata filtering or metadata without the <code>s3vectors:GetVectors</code> permission.</p> </li> </ul> </dd> </dl>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -51,6 +51,7 @@ declare const QueryVectorsCommand_base: {
  *   filter: "DOCUMENT_VALUE",
  *   returnMetadata: true || false,
  *   returnDistance: true || false,
+ *   nextToken: "STRING_VALUE",
  * };
  * const command = new QueryVectorsCommand(input);
  * const response = await client.send(command);
@@ -63,6 +64,7 @@ declare const QueryVectorsCommand_base: {
  * //     },
  * //   ],
  * //   distanceMetric: "euclidean" || "cosine", // required
+ * //   nextToken: "STRING_VALUE",
  * // };
  *
  * ```

package/dist-types/models/models_0.d.ts

@@ -736,6 +736,11 @@ export interface QueryVectorsInput {
      * @public
      */
     returnDistance?: boolean | undefined;
+    /**
+     * <p>Pagination token from a previous request. The value of this field is empty for an initial request.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
 }
 /**
  * <p>The attributes of a vector in the approximate nearest neighbor search.</p>
@@ -772,6 +777,11 @@ export interface QueryVectorsOutput {
      * @public
      */
     distanceMetric: DistanceMetric | undefined;
+    /**
+     * <p>Pagination token to be used in the subsequent page request. The field is empty if no further pagination is required.</p>
+     * @public
+     */
+    nextToken?: string | undefined;
 }
 /**
  * @public

package/dist-types/pagination/QueryVectorsPaginator.d.ts

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { QueryVectorsCommandInput, QueryVectorsCommandOutput } from "../commands/QueryVectorsCommand";
+import type { S3VectorsPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateQueryVectors: (config: S3VectorsPaginationConfiguration, input: QueryVectorsCommandInput, ...rest: any[]) => Paginator<QueryVectorsCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -2,3 +2,4 @@ export * from "./Interfaces";
 export * from "./ListIndexesPaginator";
 export * from "./ListVectorBucketsPaginator";
 export * from "./ListVectorsPaginator";
+export * from "./QueryVectorsPaginator";

package/dist-types/ts3.4/S3Vectors.d.ts

@@ -358,5 +358,12 @@ export interface S3Vectors {
       Exclude<keyof PaginationConfiguration, "client">
     >
   ): Paginator<ListVectorsCommandOutput>;
+  paginateQueryVectors(
+    args: QueryVectorsCommandInput,
+    paginationConfig?: Pick<
+      PaginationConfiguration,
+      Exclude<keyof PaginationConfiguration, "client">
+    >
+  ): Paginator<QueryVectorsCommandOutput>;
 }
 export declare class S3Vectors extends S3VectorsClient implements S3Vectors {}

package/dist-types/ts3.4/models/models_0.d.ts

@@ -184,6 +184,7 @@ export interface QueryVectorsInput {
   filter?: __DocumentType | undefined;
   returnMetadata?: boolean | undefined;
   returnDistance?: boolean | undefined;
+  nextToken?: string | undefined;
 }
 export interface QueryOutputVector {
   distance?: number | undefined;
@@ -193,6 +194,7 @@ export interface QueryOutputVector {
 export interface QueryVectorsOutput {
   vectors: QueryOutputVector[] | undefined;
   distanceMetric: DistanceMetric | undefined;
+  nextToken?: string | undefined;
 }
 export interface ListTagsForResourceInput {
   resourceArn: string | undefined;

package/dist-types/ts3.4/pagination/QueryVectorsPaginator.d.ts

@@ -0,0 +1,11 @@
+import { Paginator } from "@smithy/types";
+import {
+  QueryVectorsCommandInput,
+  QueryVectorsCommandOutput,
+} from "../commands/QueryVectorsCommand";
+import { S3VectorsPaginationConfiguration } from "./Interfaces";
+export declare const paginateQueryVectors: (
+  config: S3VectorsPaginationConfiguration,
+  input: QueryVectorsCommandInput,
+  ...rest: any[]
+) => Paginator<QueryVectorsCommandOutput>;

package/dist-types/ts3.4/pagination/index.d.ts

@@ -2,3 +2,4 @@ export * from "./Interfaces";
 export * from "./ListIndexesPaginator";
 export * from "./ListVectorBucketsPaginator";
 export * from "./ListVectorsPaginator";
+export * from "./QueryVectorsPaginator";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-s3vectors",
   "description": "AWS SDK for JavaScript S3vectors Client for Node.js, Browser and React Native",
-  "version": "3.1069.0",
+  "version": "3.1070.0",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
     "build:cjs": "node ../../scripts/compilation/inline",