ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.398.1

panoratech · Sep 17, 2024 · 89354b3 · 89354b3
1 parent 8a965d3
commit 89354b3
Show file tree

Hide file tree

Showing 25 changed files with 345 additions and 114 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -1,12 +1,12 @@
 lockVersion: 2.0.0
 id: caaaa8c3-6dd7-43a5-841e-c3193e68cc73
 management:
-  docChecksum: 4451647c3fecd12e75576c88d6e46844
+  docChecksum: ef657b2aadcc7b6b8d116b9b11322b80
   docVersion: "1.0"
-  speakeasyVersion: 1.396.9
-  generationVersion: 2.415.7
-  releaseVersion: 0.13.1
-  configChecksum: 5881ae6eaf79ded36c0abecd2d47bd0c
+  speakeasyVersion: 1.398.1
+  generationVersion: 2.415.8
+  releaseVersion: 0.13.2
+  configChecksum: 594e8b0951a87c6de2ba2291352d7ff3
   repoURL: https://github.com/panoratech/typescript-sdk.git
   installationURL: https://github.com/panoratech/typescript-sdk
   published: true
@@ -77,6 +77,7 @@ generatedFiles:
   - docs/models/components/passthroughrequestdtomethod.md
   - docs/models/components/phone.md
   - docs/models/components/projectresponse.md
+  - docs/models/components/querybody.md
   - docs/models/components/remotedata.md
   - docs/models/components/requestformat.md
   - docs/models/components/resyncstatusdto.md
@@ -613,7 +614,8 @@ generatedFiles:
   - docs/models/operations/listticketingusersrequest.md
   - docs/models/operations/listticketingusersresponse.md
   - docs/models/operations/listticketingusersresponsebody.md
-  - docs/models/operations/ragcontrollerqueryembeddingsresponsebody.md
+  - docs/models/operations/queryrequest.md
+  - docs/models/operations/queryresponsebody.md
   - docs/models/operations/remoteidrequest.md
   - docs/models/operations/requestpassthroughresponsebody.md
   - docs/models/operations/requestrequest.md
@@ -905,7 +907,7 @@ generatedFiles:
   - src/funcs/atsUsersList.ts
   - src/funcs/atsUsersRetrieve.ts
   - src/funcs/authLoginSignIn.ts
-  - src/funcs/connectionsRetrieve.ts
+  - src/funcs/connectionsList.ts
   - src/funcs/crmCompaniesCreate.ts
   - src/funcs/crmCompaniesList.ts
   - src/funcs/crmCompaniesRetrieve.ts
@@ -1025,7 +1027,7 @@ generatedFiles:
   - src/funcs/passthroughRetryidGetRetriedRequestResponse.ts
   - src/funcs/projectsCreate.ts
   - src/funcs/projectsGetProjects.ts
-  - src/funcs/ragQueryRagControllerQueryEmbeddings.ts
+  - src/funcs/ragQueryQuery.ts
   - src/funcs/syncGetPullFrequency.ts
   - src/funcs/syncResync.ts
   - src/funcs/syncStatus.ts
@@ -1095,6 +1097,7 @@ generatedFiles:
   - src/models/components/passthroughrequestdto.ts
   - src/models/components/phone.ts
   - src/models/components/projectresponse.ts
+  - src/models/components/querybody.ts
   - src/models/components/resyncstatusdto.ts
   - src/models/components/security.ts
   - src/models/components/signatureverificationdto.ts
@@ -1352,7 +1355,7 @@ generatedFiles:
   - src/models/operations/listticketingteams.ts
   - src/models/operations/listticketingticket.ts
   - src/models/operations/listticketingusers.ts
-  - src/models/operations/ragcontrollerqueryembeddings.ts
+  - src/models/operations/query.ts
   - src/models/operations/remoteid.ts
   - src/models/operations/request.ts
   - src/models/operations/retrieveaccountingaccount.ts
@@ -4116,3 +4119,15 @@ examples:
       responses:
         "200":
           application/json: []
+  query:
+    speakeasy-default-query:
+      parameters:
+        header:
+          x-connection-token: "<value>"
+      requestBody:
+        application/json: {"query": "When does Panora incorporated?", "topK": "3"}
+  listConnections:
+    speakeasy-default-list-connections:
+      responses:
+        "200":
+          application/json: []
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -12,7 +12,7 @@ generation:
   auth:
     oAuth2ClientCredentialsEnabled: false
 typescript:
-  version: 0.13.1
+  version: 0.13.2
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,20 +1,20 @@
-speakeasyVersion: 1.396.9
+speakeasyVersion: 1.398.1
 sources:
     panora-open-api-swagger:
         sourceNamespace: panora-open-api-swagger
-        sourceRevisionDigest: sha256:09a41c636f335cafb4d85225a9fdcc98b18cc03fc47615252db414011724c867
-        sourceBlobDigest: sha256:713f0a4faf73742f535cfe53b021385e24d65199df45d99217e68df12be7c42b
+        sourceRevisionDigest: sha256:e982bbcb51be9c21a9c5df52739d32ffd37c8ba27fee825a4ede576d2098b124
+        sourceBlobDigest: sha256:11ed4be0d33ec3cc2c4c95a2b21ab2e1732bcb9e9760872be99cfaa3ca2b1279
         tags:
             - latest
             - main
 targets:
     my-first-target:
         source: panora-open-api-swagger
         sourceNamespace: panora-open-api-swagger
-        sourceRevisionDigest: sha256:09a41c636f335cafb4d85225a9fdcc98b18cc03fc47615252db414011724c867
-        sourceBlobDigest: sha256:713f0a4faf73742f535cfe53b021385e24d65199df45d99217e68df12be7c42b
+        sourceRevisionDigest: sha256:e982bbcb51be9c21a9c5df52739d32ffd37c8ba27fee825a4ede576d2098b124
+        sourceBlobDigest: sha256:11ed4be0d33ec3cc2c4c95a2b21ab2e1732bcb9e9760872be99cfaa3ca2b1279
         codeSamplesNamespace: code-samples-typescript-my-first-target
-        codeSamplesRevisionDigest: sha256:030a224e95feecb4deaf3a55f955f41b15b2be46da8a1c58ba2c97ae63162434
+        codeSamplesRevisionDigest: sha256:eaf6fe560f15e64bc026cb4515d0ba1760afefd570081ed701cd310628679f64
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -311,7 +311,7 @@ run();
 
 ### [connections](docs/sdks/connections/README.md)
 
-* [retrieve](docs/sdks/connections/README.md#retrieve) - List Connections
+* [list](docs/sdks/connections/README.md#list) - List Connections
 
 ### [crm](docs/sdks/crm/README.md)
 
@@ -596,7 +596,7 @@ run();
 
 #### [rag.query](docs/sdks/query/README.md)
 
-* [ragControllerQueryEmbeddings](docs/sdks/query/README.md#ragcontrollerqueryembeddings)
+* [query](docs/sdks/query/README.md#query) - Query using RAG Search
 
 ### [sync](docs/sdks/sync/README.md)
 
@@ -1054,7 +1054,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [atsUsersList](docs/sdks/panoraatsusers/README.md#list)
 - [atsUsersRetrieve](docs/sdks/panoraatsusers/README.md#retrieve)
 - [authLoginSignIn](docs/sdks/login/README.md#signin)
-- [connectionsRetrieve](docs/sdks/connections/README.md#retrieve)
+- [connectionsList](docs/sdks/connections/README.md#list)
 - [crmCompaniesCreate](docs/sdks/companies/README.md#create)
 - [crmCompaniesList](docs/sdks/companies/README.md#list)
 - [crmCompaniesRetrieve](docs/sdks/companies/README.md#retrieve)
@@ -1174,7 +1174,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [passthroughRetryidGetRetriedRequestResponse](docs/sdks/retryid/README.md#getretriedrequestresponse)
 - [projectsCreate](docs/sdks/projects/README.md#create)
 - [projectsGetProjects](docs/sdks/projects/README.md#getprojects)
-- [ragQueryRagControllerQueryEmbeddings](docs/sdks/query/README.md#ragcontrollerqueryembeddings)
+- [ragQueryQuery](docs/sdks/query/README.md#query)
 - [syncGetPullFrequency](docs/sdks/sync/README.md#getpullfrequency)
 - [syncResync](docs/sdks/sync/README.md#resync)
 - [syncStatus](docs/sdks/sync/README.md#status)

diff --git a/RELEASES.md b/RELEASES.md
@@ -248,4 +248,14 @@ Based on:
 ### Generated
 - [typescript v0.13.1] .
 ### Releases
-- [NPM v0.13.1] https://www.npmjs.com/package/@panora/sdk/v/0.13.1 - .
+- [NPM v0.13.1] https://www.npmjs.com/package/@panora/sdk/v/0.13.1 - .
+
+## 2024-09-17 19:29:15
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.398.1 (2.415.8) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.13.2] .
+### Releases
+- [NPM v0.13.2] https://www.npmjs.com/package/@panora/sdk/v/0.13.2 - .
diff --git a/codeSamples.yaml b/codeSamples.yaml
@@ -531,8 +531,8 @@ actions:
     update:
       x-codeSamples:
         - lang: typescript
-          label: retrieveConnections
-          source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n  apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n  const result = await panora.connections.retrieve();\n  \n  // Handle the result\n  console.log(result)\n}\n\nrun();"
+          label: listConnections
+          source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n  apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n  const result = await panora.connections.list();\n  \n  // Handle the result\n  console.log(result)\n}\n\nrun();"
   - target: $["paths"]["/crm/companies"]["get"]
     update:
       x-codeSamples:
@@ -1291,8 +1291,8 @@ actions:
     update:
       x-codeSamples:
         - lang: typescript
-          label: RagController_queryEmbeddings
-          source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n  apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n  const result = await panora.rag.query.ragControllerQueryEmbeddings();\n  \n  // Handle the result\n  console.log(result)\n}\n\nrun();"
+          label: query
+          source: "import { Panora } from \"@panora/sdk\";\n\nconst panora = new Panora({\n  apiKey: \"<YOUR_API_KEY_HERE>\",\n});\n\nasync function run() {\n  const result = await panora.rag.query.query({\n    xConnectionToken: \"<value>\",\n    queryBody: {\n      query: \"When does Panora incorporated?\",\n      topK: 3,\n    },\n  });\n  \n  // Handle the result\n  console.log(result)\n}\n\nrun();"
   - target: $["paths"]["/sync/pull-frequencies"]["get"]
     update:
       x-codeSamples:

diff --git a/docs/models/components/querybody.md b/docs/models/components/querybody.md
@@ -0,0 +1,19 @@
+# QueryBody
+
+## Example Usage
+
+```typescript
+import { QueryBody } from "@panora/sdk/models/components";
+
+let value: QueryBody = {
+  query: "When does Panora incorporated?",
+  topK: 3,
+};
+```
+
+## Fields
+
+| Field                                                    | Type                                                     | Required                                                 | Description                                              | Example                                                  |
+| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
+| `query`                                                  | *string*                                                 | :heavy_check_mark:                                       | The query you want to received embeddings adn chunks for | When does Panora incorporated?                           |
+| `topK`                                                   | *number*                                                 | :heavy_minus_sign:                                       | The number of most appropriate documents for your query. | 3                                                        |
diff --git a/docs/models/operations/queryrequest.md b/docs/models/operations/queryrequest.md
@@ -0,0 +1,22 @@
+# QueryRequest
+
+## Example Usage
+
+```typescript
+import { QueryRequest } from "@panora/sdk/models/operations";
+
+let value: QueryRequest = {
+  xConnectionToken: "<value>",
+  queryBody: {
+    query: "When does Panora incorporated?",
+    topK: 3,
+  },
+};
+```
+
+## Fields
+
+| Field                                                        | Type                                                         | Required                                                     | Description                                                  |
+| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `xConnectionToken`                                           | *string*                                                     | :heavy_check_mark:                                           | The connection token                                         |
+| `queryBody`                                                  | [components.QueryBody](../../models/components/querybody.md) | :heavy_check_mark:                                           | N/A                                                          |
diff --git a/docs/models/operations/queryresponsebody.md b/docs/models/operations/queryresponsebody.md
@@ -0,0 +1,14 @@
+# QueryResponseBody
+
+## Example Usage
+
+```typescript
+import { QueryResponseBody } from "@panora/sdk/models/operations";
+
+let value: QueryResponseBody = {};
+```
+
+## Fields
+
+| Field       | Type        | Required    | Description |
+| ----------- | ----------- | ----------- | ----------- |
diff --git a/docs/models/operations/ragcontrollerqueryembeddingsresponsebody.md b/docs/models/operations/ragcontrollerqueryembeddingsresponsebody.md
diff --git a/docs/sdks/connections/README.md b/docs/sdks/connections/README.md
@@ -5,9 +5,9 @@
 
 ### Available Operations
 
-* [retrieve](#retrieve) - List Connections
+* [list](#list) - List Connections
 
-## retrieve
+## list
 
 List Connections
 
@@ -21,7 +21,7 @@ const panora = new Panora({
 });
 
 async function run() {
-  const result = await panora.connections.retrieve();
+  const result = await panora.connections.list();
 
   // Handle the result
   console.log(result)
@@ -36,7 +36,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PanoraCore } from "@panora/sdk/core.js";
-import { connectionsRetrieve } from "@panora/sdk/funcs/connectionsRetrieve.js";
+import { connectionsList } from "@panora/sdk/funcs/connectionsList.js";
 
 // Use `PanoraCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -45,7 +45,7 @@ const panora = new PanoraCore({
 });
 
 async function run() {
-  const res = await connectionsRetrieve(panora);
+  const res = await connectionsList(panora);
 
   if (!res.ok) {
     throw res.error;

diff --git a/docs/sdks/query/README.md b/docs/sdks/query/README.md
@@ -5,9 +5,11 @@
 
 ### Available Operations
 
-* [ragControllerQueryEmbeddings](#ragcontrollerqueryembeddings)
+* [query](#query) - Query using RAG Search
 
-## ragControllerQueryEmbeddings
+## query
+
+Query across your connected data sources using RAG Search
 
 ### Example Usage
 
@@ -19,7 +21,13 @@ const panora = new Panora({
 });
 
 async function run() {
-  const result = await panora.rag.query.ragControllerQueryEmbeddings();
+  const result = await panora.rag.query.query({
+    xConnectionToken: "<value>",
+    queryBody: {
+      query: "When does Panora incorporated?",
+      topK: 3,
+    },
+  });
 
   // Handle the result
   console.log(result)
@@ -34,7 +42,7 @@ The standalone function version of this method:
 
 ```typescript
 import { PanoraCore } from "@panora/sdk/core.js";
-import { ragQueryRagControllerQueryEmbeddings } from "@panora/sdk/funcs/ragQueryRagControllerQueryEmbeddings.js";
+import { ragQueryQuery } from "@panora/sdk/funcs/ragQueryQuery.js";
 
 // Use `PanoraCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -43,7 +51,13 @@ const panora = new PanoraCore({
 });
 
 async function run() {
-  const res = await ragQueryRagControllerQueryEmbeddings(panora);
+  const res = await ragQueryQuery(panora, {
+    xConnectionToken: "<value>",
+    queryBody: {
+      query: "When does Panora incorporated?",
+      topK: 3,
+    },
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -62,13 +76,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.QueryRequest](../../models/operations/queryrequest.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.RagControllerQueryEmbeddingsResponseBody](../../models/operations/ragcontrollerqueryembeddingsresponsebody.md)\>**
+**Promise\<[operations.QueryResponseBody](../../models/operations/queryresponsebody.md)\>**
 
 ### Errors
 

diff --git a/jsr.json b/jsr.json
@@ -2,7 +2,7 @@
 
 {
   "name": "@panora/sdk",
-  "version": "0.13.1",
+  "version": "0.13.2",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",