@sap-ai-sdk/document-grounding 1.4.1-20241213113708.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,119 @@
+# @sap-ai-sdk/document-grounding
+
+> [!warning]
+> This package is still in **beta** and is subject to breaking changes. Use it with caution.
+
+SAP Cloud SDK for AI is the official Software Development Kit (SDK) for **SAP AI Core**, **SAP Generative AI Hub**, and **Orchestration Service**.
+
+This package incorporates generative AI document grounding capabilities into your AI activities in SAP AI Core and SAP AI Launchpad.
+
+### Table of Contents
+
+- [Installation](#installation)
+- [Prerequisites](#prerequisites)
+- [Usage](#usage)
+  - [Create a Collection](#create-a-collection)
+  - [Create a Document](#create-a-document)
+  - [Custom Destination](#custom-destination)
+- [Local Testing](#local-testing)
+- [Support, Feedback, Contribution](#support-feedback-contribution)
+- [License](#license)
+
+## Installation
+
+```
+$ npm install @sap-ai-sdk/document-grounding
+```
+
+## Prerequisites
+
+- [Enable the AI Core service in SAP BTP](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup).
+- Configure the project with **Node.js v20 or higher** and **native ESM** support.
+
+> **Accessing the AI Core Service via the SDK**
+>
+> The SDK automatically retrieves the `AI Core` service credentials and resolves the access token needed for authentication.
+>
+> - In Cloud Foundry, it's accessed from the `VCAP_SERVICES` environment variable.
+> - In Kubernetes / Kyma environments, you have to mount the service binding as a secret instead, for more information refer to [this documentation](https://www.npmjs.com/package/@sap/xsenv#usage-in-kubernetes).
+
+## Usage
+
+The examples below demonstrate the usage of the most commonly used APIs in SAP AI Core document grounding service.
+In addition to the examples below, you can find more **sample code** [here](https://github.com/SAP/ai-sdk-js/blob/main/sample-code/src/document-grounding.ts).
+
+### Create a Collection
+
+```ts
+import
+const response =
+  await CollectionsApi.vectorV1VectorEndpointsCreateCollection(
+    {
+      title: 'ai-sdk-js-e2e',
+      embeddingConfig: {
+        modelName: 'text-embedding-ada-002-v2'
+      },
+      metadata: []
+    },
+    {
+      'AI-Resource-Group': 'default'
+    }
+  ).executeRaw();
+
+const collectionId = (response.headers.location as string).split('/').at(-2);
+```
+
+### Create a Document
+
+```ts
+const response: DocumentsListResponse =
+  await DocumentsApi.vectorV1VectorEndpointsCreateDocuments(
+    collectionId,
+    {
+      documents: [
+        {
+          metadata: [],
+          chunks: [
+            {
+              content:
+                'SAP Cloud SDK for AI is the official Software Development Kit (SDK) for SAP AI Core, SAP Generative AI Hub, and Orchestration Service.',
+              metadata: []
+            }
+          ]
+        }
+      ]
+    },
+    {
+      'AI-Resource-Group': 'default'
+    }
+  ).execute();
+```
+
+### Custom Destination
+
+When calling the `execute()` method, it is possible to provide a custom destination.
+For example, when querying deployments targeting a destination with the name `my-destination`, the following code can be used:
+
+```ts
+const response = await CollectionsApi.vectorV1VectorEndpointsDeleteCollection(
+  collectionId,
+  {
+    'AI-Resource-Group': 'default'
+  }
+).execute({
+  destinationName: 'my-destination'
+});
+```
+
+## Local Testing
+
+For local testing instructions, refer to this [section](https://github.com/SAP/ai-sdk-js/blob/main/README.md#local-testing).
+
+## Support, Feedback, Contribution
+
+Contribution and feedback are encouraged and always welcome.
+For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](https://github.com/SAP/ai-sdk-js/blob/main/CONTRIBUTING.md).
+
+## License
+
+The SAP Cloud SDK for AI is released under the [Apache License Version 2.0](http://www.apache.org/licenses/).

package/dist/client/api/collections-api.d.ts

@@ -0,0 +1,67 @@
+import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
+import type { CollectionsListResponse, CollectionRequest, Collection, CollectionCreatedResponse, CollectionPendingResponse, CollectionDeletedResponse } from './schema/index.js';
+/**
+ * Representation of the 'CollectionsApi'.
+ * This API is part of the 'api' service.
+ */
+export declare const CollectionsApi: {
+    /**
+     * Gets a list of collections.
+     * @param queryParameters - Object containing the following keys: $top, $skip, $count.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetAllCollections: (queryParameters: {
+        $top?: number;
+        $skip?: number;
+        $count?: boolean;
+    }, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<CollectionsListResponse>;
+    /**
+     * Creates a collection. This operation is asynchronous. Poll the collection resource and check the status field to understand creation status.
+     * @param body - Request body.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsCreateCollection: (body: CollectionRequest, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<any>;
+    /**
+     * Gets a specific collection by ID.
+     * @param collectionId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetCollectionById: (collectionId: string, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<Collection>;
+    /**
+     * Deletes a specific collection by ID. This operation is asynchronous. Poll the collection for a 404 status code.
+     * @param collectionId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsDeleteCollection: (collectionId: string, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<any>;
+    /**
+     * Gets a specific collection status from monitor by ID.
+     * @param id - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetCollectionCreationStatus: (id: string, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<CollectionCreatedResponse | CollectionPendingResponse>;
+    /**
+     * Gets a specific collection status from monitor by ID.
+     * @param id - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetCollectionDeletionStatus: (id: string, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<CollectionPendingResponse | CollectionDeletedResponse>;
+};
+//# sourceMappingURL=collections-api.d.ts.map

package/dist/client/api/collections-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections-api.d.ts","sourceRoot":"","sources":["../../../src/client/api/collections-api.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,UAAU,EACV,yBAAyB,EACzB,yBAAyB,EACzB,yBAAyB,EAC1B,MAAM,mBAAmB,CAAC;AAC3B;;;GAGG;AACH,eAAO,MAAM,cAAc;IACzB;;;;;OAKG;gEAEgB;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,oBAClD;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAUnD;;;;;OAKG;oDAEK,iBAAiB,oBACL;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAUnD;;;;;OAKG;6DAEa,MAAM,oBACF;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAUnD;;;;;OAKG;4DAEa,MAAM,oBACF;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAUnD;;;;;OAKG;6DAEG,MAAM,oBACQ;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAQnD;;;;;OAKG;6DAEG,MAAM,oBACQ;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;CAQpD,CAAC"}

package/dist/client/api/collections-api.js

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
+import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
+/**
+ * Representation of the 'CollectionsApi'.
+ * This API is part of the 'api' service.
+ */
+export const CollectionsApi = {
+    /**
+     * Gets a list of collections.
+     * @param queryParameters - Object containing the following keys: $top, $skip, $count.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetAllCollections: (queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/document-grounding/vector/collections', {
+        queryParameters,
+        headerParameters
+    }),
+    /**
+     * Creates a collection. This operation is asynchronous. Poll the collection resource and check the status field to understand creation status.
+     * @param body - Request body.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsCreateCollection: (body, headerParameters) => new OpenApiRequestBuilder('post', '/lm/document-grounding/vector/collections', {
+        body,
+        headerParameters
+    }),
+    /**
+     * Gets a specific collection by ID.
+     * @param collectionId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetCollectionById: (collectionId, headerParameters) => new OpenApiRequestBuilder('get', '/lm/document-grounding/vector/collections/{collectionId}', {
+        pathParameters: { collectionId },
+        headerParameters
+    }),
+    /**
+     * Deletes a specific collection by ID. This operation is asynchronous. Poll the collection for a 404 status code.
+     * @param collectionId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsDeleteCollection: (collectionId, headerParameters) => new OpenApiRequestBuilder('delete', '/lm/document-grounding/vector/collections/{collectionId}', {
+        pathParameters: { collectionId },
+        headerParameters
+    }),
+    /**
+     * Gets a specific collection status from monitor by ID.
+     * @param id - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetCollectionCreationStatus: (id, headerParameters) => new OpenApiRequestBuilder('get', '/lm/document-grounding/vector/collections/{id}/creationStatus', {
+        pathParameters: { id },
+        headerParameters
+    }),
+    /**
+     * Gets a specific collection status from monitor by ID.
+     * @param id - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetCollectionDeletionStatus: (id, headerParameters) => new OpenApiRequestBuilder('get', '/lm/document-grounding/vector/collections/{id}/deletionStatus', {
+        pathParameters: { id },
+        headerParameters
+    })
+};
+//# sourceMappingURL=collections-api.js.map

package/dist/client/api/collections-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collections-api.js","sourceRoot":"","sources":["../../../src/client/api/collections-api.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AASzD;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B;;;;;OAKG;IACH,wCAAwC,EAAE,CACxC,eAAoE,EACpE,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,KAAK,EACL,2CAA2C,EAC3C;QACE,eAAe;QACf,gBAAgB;KACjB,CACF;IACH;;;;;OAKG;IACH,uCAAuC,EAAE,CACvC,IAAuB,EACvB,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,MAAM,EACN,2CAA2C,EAC3C;QACE,IAAI;QACJ,gBAAgB;KACjB,CACF;IACH;;;;;OAKG;IACH,wCAAwC,EAAE,CACxC,YAAoB,EACpB,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,KAAK,EACL,0DAA0D,EAC1D;QACE,cAAc,EAAE,EAAE,YAAY,EAAE;QAChC,gBAAgB;KACjB,CACF;IACH;;;;;OAKG;IACH,uCAAuC,EAAE,CACvC,YAAoB,EACpB,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,QAAQ,EACR,0DAA0D,EAC1D;QACE,cAAc,EAAE,EAAE,YAAY,EAAE;QAChC,gBAAgB;KACjB,CACF;IACH;;;;;OAKG;IACH,kDAAkD,EAAE,CAClD,EAAU,EACV,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CAEvB,KAAK,EAAE,+DAA+D,EAAE;QACxE,cAAc,EAAE,EAAE,EAAE,EAAE;QACtB,gBAAgB;KACjB,CAAC;IACJ;;;;;OAKG;IACH,kDAAkD,EAAE,CAClD,EAAU,EACV,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CAEvB,KAAK,EAAE,+DAA+D,EAAE;QACxE,cAAc,EAAE,EAAE,EAAE,EAAE;QACtB,gBAAgB;KACjB,CAAC;CACL,CAAC"}

package/dist/client/api/documents-api.d.ts

@@ -0,0 +1,63 @@
+import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
+import type { DocumentResponse, Documents, DocumentCreateRequest, DocumentsListResponse, DocumentUpdateRequest } from './schema/index.js';
+/**
+ * Representation of the 'DocumentsApi'.
+ * This API is part of the 'api' service.
+ */
+export declare const DocumentsApi: {
+    /**
+     * Gets a specific document in a collection by ID.
+     * @param collectionId - Path parameter.
+     * @param documentId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetDocumentById: (collectionId: string, documentId: string, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<DocumentResponse>;
+    /**
+     * Deletes a specific document of a collection.
+     * @param collectionId - Path parameter.
+     * @param documentId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsDeleteDocument: (collectionId: string, documentId: string, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<any>;
+    /**
+     * Gets a list of documents of a collection.
+     * @param collectionId - Path parameter.
+     * @param queryParameters - Object containing the following keys: $top, $skip, $count.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetAllDocuments: (collectionId: string, queryParameters: {
+        $top?: number;
+        $skip?: number;
+        $count?: boolean;
+    }, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<Documents>;
+    /**
+     * Create and stores one or multiple documents into a collection. If omitted, 'id' will be auto-generated.
+     * @param collectionId - Path parameter.
+     * @param body - Request body.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsCreateDocuments: (collectionId: string, body: DocumentCreateRequest, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<DocumentsListResponse>;
+    /**
+     * Upserts the data of multiple documents into a collection.
+     * @param collectionId - Path parameter.
+     * @param body - Request body.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsUpdateDocuments: (collectionId: string, body: DocumentUpdateRequest, headerParameters: {
+        "AI-Resource-Group": string;
+    }) => OpenApiRequestBuilder<DocumentsListResponse>;
+};
+//# sourceMappingURL=documents-api.d.ts.map

package/dist/client/api/documents-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents-api.d.ts","sourceRoot":"","sources":["../../../src/client/api/documents-api.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,KAAK,EACV,gBAAgB,EAChB,SAAS,EACT,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAC3B;;;GAGG;AACH,eAAO,MAAM,YAAY;IACvB;;;;;;OAMG;2DAEa,MAAM,cACR,MAAM,oBACA;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAUnD;;;;;;OAMG;0DAEa,MAAM,cACR,MAAM,oBACA;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAUnD;;;;;;OAMG;2DAEa,MAAM,mBACH;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,oBAClD;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAWnD;;;;;;OAMG;2DAEa,MAAM,QACd,qBAAqB,oBACT;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAWnD;;;;;;OAMG;2DAEa,MAAM,QACd,qBAAqB,oBACT;QAAE,mBAAmB,EAAE,MAAM,CAAA;KAAE;CAWpD,CAAC"}

package/dist/client/api/documents-api.js

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
+import { OpenApiRequestBuilder } from '@sap-ai-sdk/core';
+/**
+ * Representation of the 'DocumentsApi'.
+ * This API is part of the 'api' service.
+ */
+export const DocumentsApi = {
+    /**
+     * Gets a specific document in a collection by ID.
+     * @param collectionId - Path parameter.
+     * @param documentId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetDocumentById: (collectionId, documentId, headerParameters) => new OpenApiRequestBuilder('get', '/lm/document-grounding/vector/collections/{collectionId}/documents/{documentId}', {
+        pathParameters: { collectionId, documentId },
+        headerParameters
+    }),
+    /**
+     * Deletes a specific document of a collection.
+     * @param collectionId - Path parameter.
+     * @param documentId - Path parameter.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsDeleteDocument: (collectionId, documentId, headerParameters) => new OpenApiRequestBuilder('delete', '/lm/document-grounding/vector/collections/{collectionId}/documents/{documentId}', {
+        pathParameters: { collectionId, documentId },
+        headerParameters
+    }),
+    /**
+     * Gets a list of documents of a collection.
+     * @param collectionId - Path parameter.
+     * @param queryParameters - Object containing the following keys: $top, $skip, $count.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsGetAllDocuments: (collectionId, queryParameters, headerParameters) => new OpenApiRequestBuilder('get', '/lm/document-grounding/vector/collections/{collectionId}/documents', {
+        pathParameters: { collectionId },
+        queryParameters,
+        headerParameters
+    }),
+    /**
+     * Create and stores one or multiple documents into a collection. If omitted, 'id' will be auto-generated.
+     * @param collectionId - Path parameter.
+     * @param body - Request body.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsCreateDocuments: (collectionId, body, headerParameters) => new OpenApiRequestBuilder('post', '/lm/document-grounding/vector/collections/{collectionId}/documents', {
+        pathParameters: { collectionId },
+        body,
+        headerParameters
+    }),
+    /**
+     * Upserts the data of multiple documents into a collection.
+     * @param collectionId - Path parameter.
+     * @param body - Request body.
+     * @param headerParameters - Object containing the following keys: AI-Resource-Group.
+     * @returns The request builder, use the `execute()` method to trigger the request.
+     */
+    vectorV1VectorEndpointsUpdateDocuments: (collectionId, body, headerParameters) => new OpenApiRequestBuilder('patch', '/lm/document-grounding/vector/collections/{collectionId}/documents', {
+        pathParameters: { collectionId },
+        body,
+        headerParameters
+    })
+};
+//# sourceMappingURL=documents-api.js.map

package/dist/client/api/documents-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documents-api.js","sourceRoot":"","sources":["../../../src/client/api/documents-api.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAQzD;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B;;;;;;OAMG;IACH,sCAAsC,EAAE,CACtC,YAAoB,EACpB,UAAkB,EAClB,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,KAAK,EACL,iFAAiF,EACjF;QACE,cAAc,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE;QAC5C,gBAAgB;KACjB,CACF;IACH;;;;;;OAMG;IACH,qCAAqC,EAAE,CACrC,YAAoB,EACpB,UAAkB,EAClB,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,QAAQ,EACR,iFAAiF,EACjF;QACE,cAAc,EAAE,EAAE,YAAY,EAAE,UAAU,EAAE;QAC5C,gBAAgB;KACjB,CACF;IACH;;;;;;OAMG;IACH,sCAAsC,EAAE,CACtC,YAAoB,EACpB,eAAoE,EACpE,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,KAAK,EACL,oEAAoE,EACpE;QACE,cAAc,EAAE,EAAE,YAAY,EAAE;QAChC,eAAe;QACf,gBAAgB;KACjB,CACF;IACH;;;;;;OAMG;IACH,sCAAsC,EAAE,CACtC,YAAoB,EACpB,IAA2B,EAC3B,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,MAAM,EACN,oEAAoE,EACpE;QACE,cAAc,EAAE,EAAE,YAAY,EAAE;QAChC,IAAI;QACJ,gBAAgB;KACjB,CACF;IACH;;;;;;OAMG;IACH,sCAAsC,EAAE,CACtC,YAAoB,EACpB,IAA2B,EAC3B,gBAAiD,EACjD,EAAE,CACF,IAAI,qBAAqB,CACvB,OAAO,EACP,oEAAoE,EACpE;QACE,cAAc,EAAE,EAAE,YAAY,EAAE;QAChC,IAAI;QACJ,gBAAgB;KACjB,CACF;CACJ,CAAC"}

package/dist/client/api/index.d.ts

@@ -0,0 +1,8 @@
+export * from './pipelines-api.js';
+export * from './collections-api.js';
+export * from './documents-api.js';
+export * from './search-api.js';
+export * from './retrieval-data-repository-api.js';
+export * from './retrieval-federated-search-across-data-repositories-api.js';
+export * from './schema/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/api/index.ts"],"names":[],"mappings":"AAKA,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oCAAoC,CAAC;AACnD,cAAc,8DAA8D,CAAC;AAC7E,cAAc,mBAAmB,CAAC"}

package/dist/client/api/index.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
+export * from './pipelines-api.js';
+export * from './collections-api.js';
+export * from './documents-api.js';
+export * from './search-api.js';
+export * from './retrieval-data-repository-api.js';
+export * from './retrieval-federated-search-across-data-repositories-api.js';
+export * from './schema/index.js';
+//# sourceMappingURL=index.js.map

package/dist/client/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/api/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oCAAoC,CAAC;AACnD,cAAc,8DAA8D,CAAC;AAC7E,cAAc,mBAAmB,CAAC"}