qanswer-sdk 3.1208.0-main → 3.1210.0-main

package/README.md

@@ -9,6 +9,16 @@
 
 ---
 
+## ✨ Features
+
+- **OpenAPI-Generated**: Built using OpenAPI Generator for robust and reliable API handling.  
+- **TypeScript Support**: Includes full typing for a better developer experience.  
+- **Axios Integration**: Uses Axios under the hood for HTTP requests.  
+- **Flexible Authentication**: Easily configure API key or OAuth2 token-based authentication.  
+- **Modular and Compatible**: Works in both Node.js and modern front-end bundlers like Webpack and Browserify.  
+
+---
+
 ## 📦 Installation
 
 ```bash
@@ -23,28 +33,198 @@ yarn add qanswer-sdk
 
 ---
 
-## ⚡ Quick Start
+## 🚀 Usage
+
+### Importing the SDK
+
+The SDK can be used with both TypeScript and JavaScript.
+
+🖥️ In TypeScript:
+
+```typescript
+import { Configuration, DatasetApi } from "qanswer-sdk";  
+
+// Setup configuration  
+const configuration = new Configuration({  
+  apiKey: "YOUR_API_KEY",  
+  basePath: "https://api.qanswer.com",  
+});  
+
+// Create an instance of the API you want to use  
+const datasetApiInstance = new DatasetApi(configuration);  
+
+// Example: Creating a new dataset  
+datasetApiInstance  
+  .createDataset({  
+    name: "sample_dataset",  
+    language: "en",  
+    datasetType: "qa",  
+    description: "A sample dataset",  
+  })  
+  .then((response) => {  
+    console.log("Dataset created successfully!", response);  
+  })  
+  .catch((error) => {  
+    console.error("Error creating dataset:", error);  
+  });  
+```
+
+🛠️ In JavaScript:
 
 ```javascript
-import { DefaultApi } from "qanswer-sdk";
+const { Configuration, DatasetApi } = require("qanswer-sdk");  
+
+// Setup configuration  
+const configuration = new Configuration({  
+  apiKey: "YOUR_API_KEY",  
+  basePath: "https://api.qanswer.com",  
+});  
+
+// Create an API instance  
+const datasetApiInstance = new DatasetApi(configuration);  
+
+// Example: Creating a new dataset  
+datasetApiInstance  
+  .createDataset({  
+    name: "sample_dataset",  
+    language: "en",  
+    datasetType: "qa",  
+    description: "A sample dataset",  
+  })  
+  .then((response) => {  
+    console.log("Dataset created successfully!", response);  
+  })  
+  .catch((error) => {  
+    console.error("Error creating dataset:", error);  
+  });  
+```
 
-// Create an instance of the API client
-const api = new DefaultApi();
+### 🔐 Authentication
 
-// Example: ask QAnswer a question
-api.getAnswer({ question: "What is QAnswer?" })
-   .then(response => console.log("🤖 Answer:", response.data))
-   .catch(err => console.error("❌ Error:", err));
+Authenticate QAnswer API requests using:
+
+#### API Key Authentication:
+
+Provide the API key when initializing Configuration:
+
+```typescript
+const configuration = new Configuration({  
+  apiKey: "YOUR_API_KEY",  
+}); 
 ```
 
----
+#### Bearer Token (OAuth2) Authentication:
 
-## 📖 Features
+Supply a bearer token during configuration:
 
-✨ Auto-generated from OpenAPI
-🔧 Written in TypeScript with full type safety
-⚡ Powered by Axios under the hood
-📦 Easy to install and use in Node.js or browser apps
+```typescript
+const configuration = new Configuration({  
+  accessToken: "YOUR_BEARER_TOKEN",  
+});  
+```
+
+### 📚 Available APIs
+
+The SDK is organized into separate API modules for better usability. Below are some of the key APIs with example usage.
+
+#### 📁 Dataset API
+
+Create a Dataset
+
+```typescript
+const datasetPayload = {  
+  name: "my_dataset",  
+  language: "en",  
+  datasetType: "qa",  
+  description: "A dataset for Q&A tasks",  
+};  
+
+datasetApiInstance  
+  .createDataset(datasetPayload)  
+  .then((response) => {  
+    console.log("Dataset created successfully!", response);  
+  })  
+  .catch((error) => {  
+    console.error("Error creating dataset:", error);  
+  });
+```
+
+List All Datasets
+
+```typescript
+datasetApiInstance  
+  .listDatasets()  
+  .then((datasets) => {  
+    console.log("Available datasets:", datasets);  
+  })  
+  .catch((error) => {  
+    console.error("Error retrieving datasets:", error);  
+  });  
+```
+
+#### 📑 Document API
+
+Add Q&A Pairs
+
+```typescript
+const qnaPayload = {  
+  username: "user123",  
+  dataset: "my_dataset",  
+  connector_id: 42,  
+  quota: 100,  
+  qna_pairs: [  
+    {  
+      question: "What is QAnswer?",  
+      answer: "QAnswer is an intelligent assistant platform.",  
+    },  
+  ],  
+};  
+
+qaApiInstance  
+  .addQnA(qnaPayload)  
+  .then((response) => {  
+    console.log("Q&A added successfully!", response);  
+  })  
+  .catch((error) => {  
+    console.error("Error adding Q&A pairs:", error);  
+  });  
+```
+
+#### 🕵️ PDF Search API
+
+Search in a PDF
+
+```typescript
+const pdfSearchPayload = {  
+  username: "user123",  
+  dataset: "my_dataset",  
+  filename: "document.pdf",  
+  task_name: "search",  
+};  
+
+pdfApiInstance  
+  .searchInPDF(pdfSearchPayload)  
+  .then((results) => {  
+    console.log("Search results:", results);  
+  })  
+  .catch((error) => {  
+    console.error("Error during PDF search:", error);  
+  }); 
+```
+
+### ⚙️ Custom Configuration
+
+Customize SDK behavior by passing additional settings to the Configuration object:
+
+```typescript
+const configuration = new Configuration({  
+  apiKey: "YOUR_API_KEY",  
+  basePath: "https://api.qanswer.com",  
+  baseOptions: {  
+    timeout: 10000, // Set request timeout to 10 seconds  
+  },  
+}); 
+```
 
 ---
 
@@ -61,4 +241,4 @@ This project is licensed under the MIT License
 
 ---
 
-# Made with ❤️ by The QA Company
+## Made with ❤️ by The QA Company

package/api.ts

@@ -3832,6 +3832,12 @@ export interface DocumentMetadata {
      * @memberof DocumentMetadata
      */
     'doOCR'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DocumentMetadata
+     */
+    'doLLM'?: boolean;
 }
 /**
  * Metadata of the document to be uploaded
@@ -7020,22 +7026,22 @@ export interface PageOrganization {
     'pageable'?: PageableObject;
     /**
      * 
-     * @type {SortObject}
+     * @type {boolean}
      * @memberof PageOrganization
      */
-    'sort'?: SortObject;
+    'first'?: boolean;
     /**
      * 
      * @type {boolean}
      * @memberof PageOrganization
      */
-    'first'?: boolean;
+    'last'?: boolean;
     /**
      * 
-     * @type {boolean}
+     * @type {SortObject}
      * @memberof PageOrganization
      */
-    'last'?: boolean;
+    'sort'?: SortObject;
     /**
      * 
      * @type {number}
@@ -7093,22 +7099,22 @@ export interface PageTeamWithCount {
     'pageable'?: PageableObject;
     /**
      * 
-     * @type {SortObject}
+     * @type {boolean}
      * @memberof PageTeamWithCount
      */
-    'sort'?: SortObject;
+    'first'?: boolean;
     /**
      * 
      * @type {boolean}
      * @memberof PageTeamWithCount
      */
-    'first'?: boolean;
+    'last'?: boolean;
     /**
      * 
-     * @type {boolean}
+     * @type {SortObject}
      * @memberof PageTeamWithCount
      */
-    'last'?: boolean;
+    'sort'?: SortObject;
     /**
      * 
      * @type {number}
@@ -10958,6 +10964,12 @@ export interface SocketFileMetadata {
      * @memberof SocketFileMetadata
      */
     'do_ocr'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SocketFileMetadata
+     */
+    'do_llm'?: boolean;
     /**
      * 
      * @type {string}