@functional-systems/lambdadb 0.1.3

package/dist/esm/types/rfcdate.js

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+const dateRE = /^\d{4}-\d{2}-\d{2}$/;
+export class RFCDate {
+    /**
+     * Creates a new RFCDate instance using today's date.
+     */
+    static today() {
+        return new RFCDate(new Date());
+    }
+    /**
+     * Creates a new RFCDate instance using the provided input.
+     * If a string is used then in must be in the format YYYY-MM-DD.
+     *
+     * @param date A Date object or a date string in YYYY-MM-DD format
+     * @example
+     * new RFCDate("2022-01-01")
+     * @example
+     * new RFCDate(new Date())
+     */
+    constructor(date) {
+        if (typeof date === "string" && !dateRE.test(date)) {
+            throw new RangeError("RFCDate: date strings must be in the format YYYY-MM-DD: " + date);
+        }
+        const value = new Date(date);
+        if (isNaN(+value)) {
+            throw new RangeError("RFCDate: invalid date provided: " + date);
+        }
+        this.serialized = value.toISOString().slice(0, "YYYY-MM-DD".length);
+        if (!dateRE.test(this.serialized)) {
+            throw new TypeError(`RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`);
+        }
+    }
+    toJSON() {
+        return this.toString();
+    }
+    toString() {
+        return this.serialized;
+    }
+}
+//# sourceMappingURL=rfcdate.js.map

package/dist/esm/types/rfcdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rfcdate.js","sourceRoot":"","sources":["../../../src/types/rfcdate.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,MAAM,GAAG,qBAAqB,CAAC;AAErC,MAAM,OAAO,OAAO;IAGlB;;OAEG;IACH,MAAM,CAAC,KAAK;QACV,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,IAAmB;QAC7B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,UAAU,CAClB,0DAA0D,GAAG,IAAI,CAClE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,UAAU,CAAC,kCAAkC,GAAG,IAAI,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,SAAS,CACjB,yDAAyD,IAAI,kBAAkB,IAAI,CAAC,UAAU,EAAE,CACjG,CAAC;QACJ,CAAC;IACH,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF"}

package/dist/esm/types/streams.d.ts

@@ -0,0 +1,2 @@
+export declare function isReadableStream<T = Uint8Array>(val: unknown): val is ReadableStream<T>;
+//# sourceMappingURL=streams.d.ts.map

package/dist/esm/types/streams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams.d.ts","sourceRoot":"","sources":["../../../src/types/streams.ts"],"names":[],"mappings":"AAIA,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAC7C,GAAG,EAAE,OAAO,GACX,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAc1B"}

package/dist/esm/types/streams.js

@@ -0,0 +1,15 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+export function isReadableStream(val) {
+    if (typeof val !== "object" || val === null) {
+        return false;
+    }
+    // Check for the presence of methods specific to ReadableStream
+    const stream = val;
+    // ReadableStream has methods like getReader, cancel, and tee
+    return (typeof stream.getReader === "function" &&
+        typeof stream.cancel === "function" &&
+        typeof stream.tee === "function");
+}
+//# sourceMappingURL=streams.js.map

package/dist/esm/types/streams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams.js","sourceRoot":"","sources":["../../../src/types/streams.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,UAAU,gBAAgB,CAC9B,GAAY;IAEZ,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,+DAA+D;IAC/D,MAAM,MAAM,GAAG,GAAiC,CAAC;IAEjD,6DAA6D;IAC7D,OAAO,CACL,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;QACtC,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU;QACnC,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,CACjC,CAAC;AACJ,CAAC"}

package/docs/sdks/collections/README.md

@@ -0,0 +1,551 @@
+# Collections
+(*collections*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List all collections in an existing project.
+* [create](#create) - Create a collection.
+* [delete](#delete) - Delete an existing collection.
+* [get](#get) - Get metadata of an existing collection.
+* [update](#update) - Configure a collection.
+* [query](#query) - Search a collection with a query and return the most similar documents.
+
+## list
+
+List all collections in an existing project.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="listCollections" method="get" path="/collections" -->
+```typescript
+import { LambdaDB } from "@functional-systems/lambdadb";
+
+const lambdaDB = new LambdaDB({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const result = await lambdaDB.collections.list();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
+import { collectionsList } from "@functional-systems/lambdadb/funcs/collectionsList.js";
+
+// Use `LambdaDBCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const lambdaDB = new LambdaDBCore({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const res = await collectionsList(lambdaDB);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("collectionsList failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.ListCollectionsResponse](../../models/operations/listcollectionsresponse.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.UnauthenticatedError  | 401                          | application/json             |
+| errors.ResourceNotFoundError | 404                          | application/json             |
+| errors.TooManyRequestsError  | 429                          | application/json             |
+| errors.InternalServerError   | 500                          | application/json             |
+| errors.LambdaDBDefaultError  | 4XX, 5XX                     | \*/\*                        |
+
+## create
+
+Create a collection.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="createCollection" method="post" path="/collections" -->
+```typescript
+import { LambdaDB } from "@functional-systems/lambdadb";
+
+const lambdaDB = new LambdaDB({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const result = await lambdaDB.collections.create({
+    collectionName: "example-collection-name",
+    indexConfigs: {
+      "example-field1": {
+        type: "text",
+        analyzers: [
+          "english",
+        ],
+      },
+      "example-field2": {
+        type: "vector",
+        dimensions: 128,
+        similarity: "cosine",
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
+import { collectionsCreate } from "@functional-systems/lambdadb/funcs/collectionsCreate.js";
+
+// Use `LambdaDBCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const lambdaDB = new LambdaDBCore({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const res = await collectionsCreate(lambdaDB, {
+    collectionName: "example-collection-name",
+    indexConfigs: {
+      "example-field1": {
+        type: "text",
+        analyzers: [
+          "english",
+        ],
+      },
+      "example-field2": {
+        type: "vector",
+        dimensions: 128,
+        similarity: "cosine",
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("collectionsCreate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.CreateCollectionRequest](../../models/operations/createcollectionrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.CreateCollectionResponse](../../models/operations/createcollectionresponse.md)\>**
+
+### Errors
+
+| Error Type                        | Status Code                       | Content Type                      |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.BadRequestError            | 400                               | application/json                  |
+| errors.UnauthenticatedError       | 401                               | application/json                  |
+| errors.ResourceAlreadyExistsError | 409                               | application/json                  |
+| errors.TooManyRequestsError       | 429                               | application/json                  |
+| errors.InternalServerError        | 500                               | application/json                  |
+| errors.LambdaDBDefaultError       | 4XX, 5XX                          | \*/\*                             |
+
+## delete
+
+Delete an existing collection.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="deleteCollection" method="delete" path="/collections/{collectionName}" -->
+```typescript
+import { LambdaDB } from "@functional-systems/lambdadb";
+
+const lambdaDB = new LambdaDB({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const result = await lambdaDB.collections.delete({
+    collectionName: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
+import { collectionsDelete } from "@functional-systems/lambdadb/funcs/collectionsDelete.js";
+
+// Use `LambdaDBCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const lambdaDB = new LambdaDBCore({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const res = await collectionsDelete(lambdaDB, {
+    collectionName: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("collectionsDelete failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.DeleteCollectionRequest](../../models/operations/deletecollectionrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[models.MessageResponse](../../models/messageresponse.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.UnauthenticatedError  | 401                          | application/json             |
+| errors.ResourceNotFoundError | 404                          | application/json             |
+| errors.TooManyRequestsError  | 429                          | application/json             |
+| errors.InternalServerError   | 500                          | application/json             |
+| errors.LambdaDBDefaultError  | 4XX, 5XX                     | \*/\*                        |
+
+## get
+
+Get metadata of an existing collection.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="getCollection" method="get" path="/collections/{collectionName}" -->
+```typescript
+import { LambdaDB } from "@functional-systems/lambdadb";
+
+const lambdaDB = new LambdaDB({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const result = await lambdaDB.collections.get({
+    collectionName: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
+import { collectionsGet } from "@functional-systems/lambdadb/funcs/collectionsGet.js";
+
+// Use `LambdaDBCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const lambdaDB = new LambdaDBCore({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const res = await collectionsGet(lambdaDB, {
+    collectionName: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("collectionsGet failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetCollectionRequest](../../models/operations/getcollectionrequest.md)                                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetCollectionResponse](../../models/operations/getcollectionresponse.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.UnauthenticatedError  | 401                          | application/json             |
+| errors.ResourceNotFoundError | 404                          | application/json             |
+| errors.TooManyRequestsError  | 429                          | application/json             |
+| errors.InternalServerError   | 500                          | application/json             |
+| errors.LambdaDBDefaultError  | 4XX, 5XX                     | \*/\*                        |
+
+## update
+
+Configure a collection.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="updateCollection" method="patch" path="/collections/{collectionName}" -->
+```typescript
+import { LambdaDB } from "@functional-systems/lambdadb";
+
+const lambdaDB = new LambdaDB({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const result = await lambdaDB.collections.update({
+    collectionName: "<value>",
+    requestBody: {
+      indexConfigs: {
+        "example-field1": {
+          type: "text",
+          analyzers: [
+            "english",
+          ],
+        },
+        "example-field2": {
+          type: "vector",
+          dimensions: 128,
+          similarity: "cosine",
+        },
+        "example-field3": {
+          type: "keyword",
+        },
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
+import { collectionsUpdate } from "@functional-systems/lambdadb/funcs/collectionsUpdate.js";
+
+// Use `LambdaDBCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const lambdaDB = new LambdaDBCore({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const res = await collectionsUpdate(lambdaDB, {
+    collectionName: "<value>",
+    requestBody: {
+      indexConfigs: {
+        "example-field1": {
+          type: "text",
+          analyzers: [
+            "english",
+          ],
+        },
+        "example-field2": {
+          type: "vector",
+          dimensions: 128,
+          similarity: "cosine",
+        },
+        "example-field3": {
+          type: "keyword",
+        },
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("collectionsUpdate failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.UpdateCollectionRequest](../../models/operations/updatecollectionrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.UpdateCollectionResponse](../../models/operations/updatecollectionresponse.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.BadRequestError       | 400                          | application/json             |
+| errors.UnauthenticatedError  | 401                          | application/json             |
+| errors.ResourceNotFoundError | 404                          | application/json             |
+| errors.TooManyRequestsError  | 429                          | application/json             |
+| errors.InternalServerError   | 500                          | application/json             |
+| errors.LambdaDBDefaultError  | 4XX, 5XX                     | \*/\*                        |
+
+## query
+
+Search a collection with a query and return the most similar documents.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="queryCollection" method="post" path="/collections/{collectionName}/query" -->
+```typescript
+import { LambdaDB } from "@functional-systems/lambdadb";
+
+const lambdaDB = new LambdaDB({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const result = await lambdaDB.collections.query({
+    collectionName: "<value>",
+    requestBody: {
+      size: 2,
+      query: {
+        "queryString": {
+          "query": "example-field1:example-value",
+        },
+      },
+    },
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { LambdaDBCore } from "@functional-systems/lambdadb/core.js";
+import { collectionsQuery } from "@functional-systems/lambdadb/funcs/collectionsQuery.js";
+
+// Use `LambdaDBCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const lambdaDB = new LambdaDBCore({
+  projectApiKey: "<YOUR_PROJECT_API_KEY>",
+});
+
+async function run() {
+  const res = await collectionsQuery(lambdaDB, {
+    collectionName: "<value>",
+    requestBody: {
+      size: 2,
+      query: {
+        "queryString": {
+          "query": "example-field1:example-value",
+        },
+      },
+    },
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("collectionsQuery failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.QueryCollectionRequest](../../models/operations/querycollectionrequest.md)                                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.QueryCollectionResponse](../../models/operations/querycollectionresponse.md)\>**
+
+### Errors
+
+| Error Type                   | Status Code                  | Content Type                 |
+| ---------------------------- | ---------------------------- | ---------------------------- |
+| errors.BadRequestError       | 400                          | application/json             |
+| errors.UnauthenticatedError  | 401                          | application/json             |
+| errors.ResourceNotFoundError | 404                          | application/json             |
+| errors.TooManyRequestsError  | 429                          | application/json             |
+| errors.InternalServerError   | 500                          | application/json             |
+| errors.LambdaDBDefaultError  | 4XX, 5XX                     | \*/\*                        |