@functional-systems/lambdadb 0.1.5 → 0.2.0

package/docs/sdks/collections/README.md

@@ -1,551 +0,0 @@
-# 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                     | \*/\*                        |