@or-sdk/graph 1.3.2 → 1.4.0-beta.1448.0

package/README.md

@@ -1,19 +1,31 @@
-## Overview
+# Graphs SDK
 
-The `@or-sdk/graph` package provides a client for working with the graphs in OneReach.ai. With this client, you can perform operations such as querying graphs, creating new graphs and managing saved queries.
+The `@or-sdk/graphs` package provides a client for working with the Graphs system in OneReach.ai. With this client, you can perform operations such as creating graphs, executing queries, managing graph properties, and working with saved queries.
 
-The OneReach.ai Graphs application is a graph-based database that allows you to store and manipulate data using nodes and edges. You can use it to model complex relationships between entities and perform complex queries on them.
+## Concepts
 
-The database implements the openCypher query language, which is a declarative SQL-like language for querying graph databases. You can learn more about openCypher by visiting the [official documentation](https://redis.io/docs/stack/graph/cypher_support/).
+### Graph
 
-The OneReach.ai Graphs application is built on top of RedisGraph, which is a graph database that uses the Redis store as its underlying storage engine.
+A graph is a data structure that consists of nodes and relationships between those nodes. In the Graphs system, a graph can represent various types of entities and their relationships, allowing you to organize and structure data in a way that represents real-world scenarios.
+
+### Node
+
+A node is an individual entity within a graph that represents a single data item. Nodes can have properties that store information about the entity as key-value pairs. They can also have one or more labels, which help to classify nodes into groups or categories.
+
+### Relationship
+
+A relationship is a connection between two nodes in a graph. It represents how the entities are related or connected. Relationships can have properties that store information about the connection as key-value pairs. They also have a relationship type, which helps to classify the relationship based on its purpose or meaning.
+
+### Query
+
+A query is a statement that is used to interact with the Graphs system, including creating, updating, or retrieving data from a graph. The query language used in the OneReach.ai Graphs system is based on [Cypher](https://neo4j.com/developer/cypher/), which is a powerful and expressive declarative graph query language.
 
 ## Installation
 
 To install the package, run the following command:
 
 ```
-$ npm install @or-sdk/graph
+$ npm install @or-sdk/graphs
 ```
 
 ## Usage
@@ -21,184 +33,352 @@ $ npm install @or-sdk/graph
 To use the `Graphs` client, you need to create an instance of the class with the appropriate configuration options. You can either provide the direct API URL or the service discovery URL. Here is an example:
 
 ```typescript
-import { Graphs } from '@or-sdk/graph';
+import { Graphs } from '@or-sdk/graphs';
 
 // with direct api url
-const graph = new Graphs({
+const graphs = new Graphs({
   token: 'my-account-token-string',
-  graphUrl: 'http://example.graph/endpoint'
+  graphUrl: 'http://example.graphs/endpoint'
 });
 
 // with service discovery(slower)
-const graph = new Graphs({
+const graphs = new Graphs({
   token: 'my-account-token-string',
-  discoveryUrl: 'http://example.graph/endpoint'
+  discoveryUrl: 'http://example.graphs/endpoint'
 });
 ```
 
-Once you have an instance of the `Graphs`
-client, you can use its methods to interact with the OneReach.ai Graphs application. The available methods are:
-
+Once you have an instance of the `Graphs` client, you can use its methods to interact with the OneReach.ai Graphs system. The available methods are:
 
 ### `query`
-Executes a query on a graph and returns the results.
+
+Execute a query in a graph to retrieve, create, or manipulate data stored in the graph.
 
 #### Params
-- `[0].query: string` - Cypher Query to execute
-- `[0].query: graph` - Graph name to execute the query in
-- `[0].params?: Object` - Optional substitution params.
+- `query`: `ExecuteQueryArgs` - The query object containing the graph name, the query string, and optional query parameters
 
 #### Example
-```typescript
-type Place = Node<{ name: string; description: string; lat: number; lng: number }>
 
-const res = await graph.query<{ p: Place }>({
+In this example, the `query` method executes a Cypher query to match nodes with the label "Place" where the `name` property equals "CoffeePlace", and returns the matching nodes.
+
+```typescript
+const results = await graphs.query<{ p: Place }>({
   graph: 'places',
   query: 'MATCH (p: Place) WHERE p.name = $name RETURN p',
-  params: { name: 'CoffeePlace' }
+  params: { name: 'CoffeePlace' },
 });
 
-console.log(res[0].n.name)
-// Outputs: "CoffeePlace"
-
+// Example response
+[
+  {
+    p: {
+      id: 1,
+      labels: ['Place'],
+      properties: {
+        name: 'CoffeePlace',
+        description: 'A cozy place for coffee lovers',
+        lat: 40.7128,
+        lng: -74.0060,
+      },
+    },
+  },
+]
 ```
 
-### `listGraphs`
-Lists all graphs available to the authenticated user.
+### `createGraph`
+
+Create a new graph with a specified name and optional description and imageUrl.
 
 #### Params
-- `[0]?: string` - Optional name of graph to search for.
+- `graph`: `Graph` - The graph object containing the name, and optional description and imageUrl
 
 #### Example
+
+In this example, the `createGraph` method creates a new graph with the name "places", description "A graph of places and their relationships", and an imageUrl for the graph's icon.
+
 ```typescript
-const graphs = await graph.listGraphs();
+const result = await graphs.createGraph({
+  name: 'places',
+  description: 'A graph of places and their relationships',
+  imageUrl: 'http://example.com/graph-icon.png',
+});
 
-console.log(graphs.items);
-// Outputs: Array<Graph>
+// Example response
+{
+  ok: 1,
+}
 ```
 
-### `getGraphInfo`
-Gets detailed information about a specific graph.
+### `listGraphs`
+
+Retrieve a list of graphs from the Graphs system, optionally filtering by a graph name.
 
 #### Params
-- `[0]: string` - Name of graph to get info for.
+- `name`: `string` (optional) - The name of the graph to search for.
+
+#### Returns
+- `Promise<List<Graph>>`: A promise containing a list of graph objects.
 
 #### Example
-```typescript
-const result = await graph.getGraphInfo('graph-name');
 
-console.log(result);
-// Outputs: GraphInfo object
+In this example, the `listGraphs` method fetches a list of graphs from the Graphs system.
+
+```typescript
+const graphsList = await graphs.listGraphs();
+
+console.log(graphsList.items);
+// Example output
+// [
+//   {
+//     name: 'places',
+//     description: 'A graph of places and their relationships',
+//     imageUrl: 'http://example.com/graph-icon.png',
+//   },
+//   {
+//     name: 'people',
+//     description: 'A graph of people and their relationships',
+//     imageUrl: 'http://example.com/people-graph-icon.png',
+//   },
+// ]
+
+// If you want to search for a specific graph by name
+const specificGraphsList = await graphs.listGraphs('places');
+
+console.log(specificGraphsList.items);
+// Example output
+// [
+//   {
+//     name: 'places',
+//     description: 'A graph of places and their relationships',
+//     imageUrl: 'http://example.com/graph-icon.png',
+//   },
+// ]
 ```
 
-### `createGraph`
-Creates a new graph.
+The `listGraphs` method helps you fetch information about the available graphs or a specific graph by name so you can manage them or execute queries on them using other methods available in the SDK.
+
+### `getGraphInfo`
+
+Retrieve detailed information about a graph, including its labels and relationship types, by specifying its name.
 
 #### Params
-- `[0]: Graph` - New graph to create.
+- `name`: `string` - The name of the graph for which you want to obtain information.
+
+#### Returns
+- `Promise<GraphInfo>`: A promise containing information about the requested graph.
 
 #### Example
-```typescript
-const result = await graph.createGraph({
-  name: 'graph-name',
-  description: 'First steps in graphs',
-});
 
-console.log(result);
-// Outputs: WriteResponse object
+In this example, the `getGraphInfo` method fetches information about the "places" graph.
+
+```typescript
+const graphInfo = await graphs.getGraphInfo("places");
+
+console.log(graphInfo);
+// Example output
+// {
+//   name: 'places',
+//   description: 'A graph of places and their relationships',
+//   imageUrl: 'http://example.com/graph-icon.png',
+//   labels: ['Place', 'City', 'Country'],
+//   relationshipTypes: ['LOCATED_IN', 'CONNECTED_TO']
+// }
 ```
 
+The `getGraphInfo` method allows you to retrieve detailed information about a specific graph, such as its labels and relationship types, so you can understand the structure of the graph and use this information when working with queries or managing the graph.
+
 ### `updateGraph`
-Updates an existing graph.
+
+Update the properties of an existing graph in the Graphs system, such as the description or imageUrl.
 
 #### Params
-- `[0]: Graph` - Graph to update.
+- `graph`: `Graph` - The graph object containing the name of the graph to update, and any properties (description or imageUrl) that you want to update.
+
+#### Returns
+- `Promise<WriteResponse>`: A promise containing an object with a property 'ok' indicating the success of the update operation.
 
 #### Example
+
+In this example, the `updateGraph` method updates the description and imageUrl properties of an existing graph named "places".
+
 ```typescript
-const result = await graph.updateGraph({
-  name: 'graph-name',
-  description: 'First steps in graphs',
+const updateResult = await graphs.updateGraph({
+  name: 'places',
+  description: 'An updated description for the places graph',
+  imageUrl: 'http://example.com/updated-graph-icon.png',
 });
 
-console.log(result);
-// Outputs: WriteResponse object
+console.log(updateResult);
+// Example output
+// { ok: 1 }
 ```
 
+The `updateGraph` method helps you modify the properties of an existing graph in the Graphs system. Keep in mind that you need to provide the `name` property of the graph you want to update, along with any of the properties you want to modify (description or imageUrl).
+
 ### `deleteGraph`
-Deletes an existing graph.
+
+Delete a graph by its name from the Graphs system.
 
 #### Params
-- `[0]: string` - Name of graph to delete.
+- `name`: `string` - The name of the graph to delete.
+
+#### Returns
+- `Promise<WriteResponse>`: A promise containing a write response object indicating the success status of the operation.
 
 #### Example
+
+In this example, the `deleteGraph` method deletes a graph with the name "places" from the Graphs system.
+
 ```typescript
-const result = await graph.deleteGraph('graph-name');
+const result = await graphs.deleteGraph('places');
 
 console.log(result);
-// Outputs: WriteResponse object
+// Example output
+// {
+//   ok: 1,
+// }
 ```
 
+Using the `deleteGraph` method, you can remove a graph from the Graphs system if you no longer need it or if you want to clean up resources. Keep in mind that deleting a graph permanently removes its data and cannot be undone. Ensure you have proper backups or data exports before performing this operation.
+
 ### `saveQuery`
-Saves a new Cypher query for future reuse.
+
+Save a query to the Graphs system for future reuse. This allows you to store frequently used queries for easy access and execution.
 
 #### Params
-- `[0]: string` - Graph name to save query for.
-- `[1]: Query` - Query to save.
+- `graph`: `string` - The name of the graph that the query belongs to.
+- `query`: `Query` - The query object containing the name, query string, and optional description and parameters.
+
+#### Returns
+- `Promise<WriteResponse>`: A promise containing a write response object indicating the success of the operation.
 
 #### Example
+
+In this example, the `saveQuery` method saves a query to the Graphs system for the "places" graph. The query finds places with the label "Place" that have a `name` property equal to a given value.
+
 ```typescript
-const result = await graph.saveQuery('graph-name', {
-  name: 'query-name',
+const query: Query = {
+  name: 'findPlaceByName',
   query: 'MATCH (p: Place) WHERE p.name = $name RETURN p',
-});
+  description: 'Find a place by its name',
+  params: { name: 'string' },
+};
 
-console.log(result);
-// Outputs: WriteResponse object
+const result = await graphs.saveQuery('places', query);
+
+// Example response
+// {
+//   ok: 1,
+// }
 ```
 
+The `saveQuery` method makes it easy to store frequently used queries to the Graphs system, allowing you to execute them later without defining the query each time. You can also manage the saved queries using other methods available in the SDK, such as `listQueries`, `getQuery`, and `deleteQuery`.
+
 ### `listQueries`
-Lists all saved queries for a graph.
+
+Retrieve a list of saved queries for a specific graph, optionally filtering by a query name.
 
 #### Params
-- `[0]: string` - Name of graph to list queries for.
-- `[1]?: string` - Optional name of query to search for.
+- `graph`: `string` - The name of the graph for which to list saved queries.
+- `name`: `string` (optional) - The name of the query to search for.
+
+#### Returns
+- `Promise<List<Query>>`: A promise containing a list of saved query objects.
 
 #### Example
-```typescript
-const queries = await graph.listQueries('graph-name');
 
-console.log(queries.items);
-// Outputs: Array<Query> object
+In this example, the `listQueries` method fetches a list of saved queries for a graph named "places".
+
+```typescript
+const queriesList = await graphs.listQueries('places');
+
+console.log(queriesList.items);
+// Example output
+// [
+//   {
+//     name: 'find_place_by_name',
+//     query: 'MATCH (p:Place) WHERE p.name = $name RETURN p',
+//     description: 'Find a place by its name',
+//     params: { name: 'string' },
+//   },
+//   {
+//     name: 'find_nearby_places',
+//     query: 'MATCH (p:Place) WHERE p.lat between $latMin and $latMax AND p.lng between $lngMin and $lngMax RETURN p',
+//     description: 'Find nearby places based on latitude and longitude ranges',
+//     params: { latMin: 'number', latMax: 'number', lngMin: 'number', lngMax: 'number' },
+//   },
+// ]
+
+// If you want to search for a specific saved query by name
+const specificQueriesList = await graphs.listQueries('places', 'find_place_by_name');
+
+console.log(specificQueriesList.items);
+// Example output
+// [
+//   {
+//     name: 'find_place_by_name',
+//     query: 'MATCH (p:Place) WHERE p.name = $name RETURN p',
+//     description: 'Find a place by its name',
+//     params: { name: 'string' },
+//   },
+// ]
 ```
 
+The `listQueries` method allows you to fetch information about saved queries for a specific graph so you can execute them or manage them using other methods available in the SDK.
+
 ### `getQuery`
-Gets detailed information about a specific saved query.
+
+Retrieve a single saved query by its name from a specified graph.
 
 #### Params
-- `[0]: string` - Name of graph the query belongs to.
-- `[1]: string` - Name of query to get info for.
+- `graph`: `string` - The name of the graph to which the saved query belongs.
+- `name`: `string` - The name of the saved query to fetch.
+
+#### Returns
+- `Promise<Query>`: A promise containing a query object with details of the saved query.
 
 #### Example
-```typescript
-const result = await graph.getQuery('graph-name', 'query-name');
 
-console.log(result);
-// Outputs: Query object
+In this example, the `getQuery` method retrieves a saved query named "find_places" from the "places" graph.
+
+```typescript
+const query = await graphs.getQuery('places', 'find_places');
+
+console.log(query);
+// Example output
+// {
+//   name: 'find_places',
+//   query: 'MATCH (p: Place) WHERE p.name = $name RETURN p',
+//   description: 'Find places by name',
+//   params: { name: 'string' },
+// }
 ```
 
+The `getQuery` method helps you fetch the details of a specific saved query from a graph so that you can review its functionality, update its properties, or delete it if necessary using other SDK methods.
+
 ### `deleteQuery`
-Deletes a saved query.
+
+Delete a saved query from a graph in the Graphs system.
 
 #### Params
-- `[0]: string` - Name of graph the query belongs to.
-- `[1]: string` - Name of query to delete.
+- `graph`: `string` - The name of the graph the saved query belongs to.
+- `name`: `string` - The name of the saved query to delete.
+
+#### Returns
+- `Promise<WriteResponse>`: A promise containing the write response indicating the success or failure of the deletion.
 
 #### Example
+
+In this example, the `deleteQuery` method deletes a saved query named "findPopularPlaces" from the "places" graph.
+
 ```typescript
-const result = await graph.deleteQuery('graph-name', 'query-name');
+const result = await graphs.deleteQuery('places', 'findPopularPlaces');
 
 console.log(result);
-// Outputs: WriteResponse object
+// Example output
+// {
+//   ok: 1,
+// }
 ```
 
+Use the `deleteQuery` method to maintain and manage your saved queries in a graph by deleting the ones that are no longer needed or relevant. This helps with keeping your Graphs system organized and efficient.

package/dist/cjs/Graphs.js

@@ -202,6 +202,23 @@ var Graphs = (function (_super) {
             });
         });
     };
+    Graphs.prototype.textToCypher = function (graph, text) {
+        return __awaiter(this, void 0, void 0, function () {
+            var query;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4, this.callApiV2({
+                            data: { text: text },
+                            method: 'POST',
+                            route: "graphs/".concat(graph, "/text-to-cypher"),
+                        })];
+                    case 1:
+                        query = (_a.sent()).query;
+                        return [2, query];
+                }
+            });
+        });
+    };
     return Graphs;
 }(base_1.Base));
 exports.Graphs = Graphs;

package/dist/cjs/Graphs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoD;AAapD,yCAA0C;AAE1C;IAA4B,0BAAI;IAC9B,gBAAY,MAAmB;QACrB,IAAA,KAAK,GAAwC,MAAM,MAA9C,EAAE,YAAY,GAA0B,MAAM,aAAhC,EAAE,SAAS,GAAe,MAAM,UAArB,EAAE,QAAQ,GAAK,MAAM,SAAX,CAAY;eAE5D,kBAAM;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,SAAS,WAAA;YACT,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAmBY,sBAAK,GAAlB,UAAsB,EAA0C;YAAxC,KAAK,WAAA,EAAE,MAAM,YAAA,EAAE,KAAK,WAAA;;;gBAC1C,WAAO,IAAI,CAAC,SAAS,CAAW;wBAC9B,IAAI,EAAE;4BACJ,KAAK,OAAA;4BACL,MAAM,QAAA;yBACP;wBACD,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,iBAAU,KAAK,WAAQ;qBAC/B,CAAC,EAAC;;;KACJ;IASY,2BAAU,GAAvB,UAAwB,IAAa;;;;;4BACtB,WAAM,IAAI,CAAC,SAAS,CAAqB;4BACpD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,QAAQ;4BACf,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,CAAC,EAAE;yBAC7B,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,WAAO,IAAA,eAAQ,EAAQ,IAAI,CAAC,EAAC;;;;KAC9B;IASY,6BAAY,GAAzB,UAA0B,IAAY;;;gBACpC,WAAO,IAAI,CAAC,SAAS,CAAY;wBAC/B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,IAAI,CAAE;qBACxB,CAAC,EAAC;;;KACJ;IAWY,4BAAW,GAAxB,UAAyB,KAAY;;;gBACnC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,IAAI,EAAE,KAAK;wBACX,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,QAAQ;qBAChB,CAAC,EAAC;;;KACJ;IAWY,4BAAW,GAAxB,UAAyB,KAAY;;;;gBAC3B,IAAI,GAAc,KAAK,KAAnB,EAAK,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAF,CAAW;gBAEhC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,KAAK,EAAE,iBAAU,IAAI,CAAE;wBACvB,MAAM,EAAE,KAAK;wBACb,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IASY,4BAAW,GAAxB,UAAyB,IAAY;;;gBACnC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,iBAAU,IAAI,CAAE;qBACxB,CAAC,EAAC;;;KACJ;IAQY,0BAAS,GAAtB,UAAuB,KAAa,EAAE,EAAyB;QAAvB,IAAA,IAAI,UAAA,EAAK,KAAK,cAAhB,QAAkB,CAAF;;;gBACpD,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;wBACxC,IAAI,EAAE,KAAK;qBACZ,CAAC,EAAC;;;KACJ;IAUY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,IAAa;;;;;4BACnC,WAAM,IAAI,CAAC,SAAS,CAAsB;4BACxD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,iBAAU,KAAK,aAAU;4BAChC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,CAAC,EAAE;yBAC7B,CAAC,EAAA;;wBAJI,OAAO,GAAG,SAId;wBAEF,WAAO,IAAA,eAAQ,EAAQ,OAAO,CAAC,EAAC;;;;KACjC;IAUY,yBAAQ,GAArB,UAAsB,KAAa,EAAE,IAAY;;;gBAC/C,WAAO,IAAI,CAAC,SAAS,CAAQ;wBAC3B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;qBACzC,CAAC,EAAC;;;KACJ;IAUY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,IAAY;;;gBAClD,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;qBACzC,CAAC,EAAC;;;KACJ;IACH,aAAC;AAAD,CAAC,AAvLD,CAA4B,WAAI,GAuL/B;AAvLY,wBAAM"}
+{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoD;AAapD,yCAA0C;AAE1C;IAA4B,0BAAI;IAC9B,gBAAY,MAAmB;QACrB,IAAA,KAAK,GAAwC,MAAM,MAA9C,EAAE,YAAY,GAA0B,MAAM,aAAhC,EAAE,SAAS,GAAe,MAAM,UAArB,EAAE,QAAQ,GAAK,MAAM,SAAX,CAAY;eAE5D,kBAAM;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,SAAS,WAAA;YACT,UAAU,EAAE,QAAQ;SACrB,CAAC;IACJ,CAAC;IAmBY,sBAAK,GAAlB,UAAsB,EAA0C;YAAxC,KAAK,WAAA,EAAE,MAAM,YAAA,EAAE,KAAK,WAAA;;;gBAC1C,WAAO,IAAI,CAAC,SAAS,CAAW;wBAC9B,IAAI,EAAE;4BACJ,KAAK,OAAA;4BACL,MAAM,QAAA;yBACP;wBACD,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,iBAAU,KAAK,WAAQ;qBAC/B,CAAC,EAAC;;;KACJ;IASY,2BAAU,GAAvB,UAAwB,IAAa;;;;;4BACtB,WAAM,IAAI,CAAC,SAAS,CAAqB;4BACpD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,QAAQ;4BACf,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,CAAC,EAAE;yBAC7B,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,WAAO,IAAA,eAAQ,EAAQ,IAAI,CAAC,EAAC;;;;KAC9B;IASY,6BAAY,GAAzB,UAA0B,IAAY;;;gBACpC,WAAO,IAAI,CAAC,SAAS,CAAY;wBAC/B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,IAAI,CAAE;qBACxB,CAAC,EAAC;;;KACJ;IAWY,4BAAW,GAAxB,UAAyB,KAAY;;;gBACnC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,IAAI,EAAE,KAAK;wBACX,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,QAAQ;qBAChB,CAAC,EAAC;;;KACJ;IAWY,4BAAW,GAAxB,UAAyB,KAAY;;;;gBAC3B,IAAI,GAAc,KAAK,KAAnB,EAAK,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAF,CAAW;gBAEhC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,KAAK,EAAE,iBAAU,IAAI,CAAE;wBACvB,MAAM,EAAE,KAAK;wBACb,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IASY,4BAAW,GAAxB,UAAyB,IAAY;;;gBACnC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,iBAAU,IAAI,CAAE;qBACxB,CAAC,EAAC;;;KACJ;IAQY,0BAAS,GAAtB,UAAuB,KAAa,EAAE,EAAyB;QAAvB,IAAA,IAAI,UAAA,EAAK,KAAK,cAAhB,QAAkB,CAAF;;;gBACpD,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;wBACxC,IAAI,EAAE,KAAK;qBACZ,CAAC,EAAC;;;KACJ;IAUY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,IAAa;;;;;4BACnC,WAAM,IAAI,CAAC,SAAS,CAAsB;4BACxD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,iBAAU,KAAK,aAAU;4BAChC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,CAAC,EAAE;yBAC7B,CAAC,EAAA;;wBAJI,OAAO,GAAG,SAId;wBAEF,WAAO,IAAA,eAAQ,EAAQ,OAAO,CAAC,EAAC;;;;KACjC;IAUY,yBAAQ,GAArB,UAAsB,KAAa,EAAE,IAAY;;;gBAC/C,WAAO,IAAI,CAAC,SAAS,CAAQ;wBAC3B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;qBACzC,CAAC,EAAC;;;KACJ;IAUY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,IAAY;;;gBAClD,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;qBACzC,CAAC,EAAC;;;KACJ;IAcY,6BAAY,GAAzB,UAA0B,KAAa,EAAE,IAAY;;;;;4BACjC,WAAM,IAAI,CAAC,SAAS,CAAqB;4BACzD,IAAI,EAAE,EAAE,IAAI,MAAA,EAAE;4BACd,MAAM,EAAE,MAAM;4BACd,KAAK,EAAE,iBAAU,KAAK,oBAAiB;yBACxC,CAAC,EAAA;;wBAJM,KAAK,GAAK,CAAA,SAIhB,CAAA,MAJW;wBAMb,WAAO,KAAK,EAAC;;;;KACd;IACH,aAAC;AAAD,CAAC,AA7MD,CAA4B,WAAI,GA6M/B;AA7MY,wBAAM"}

package/dist/esm/Graphs.js

@@ -124,5 +124,15 @@ export class Graphs extends Base {
             });
         });
     }
+    textToCypher(graph, text) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { query } = yield this.callApiV2({
+                data: { text },
+                method: 'POST',
+                route: `graphs/${graph}/text-to-cypher`,
+            });
+            return query;
+        });
+    }
 }
 //# sourceMappingURL=Graphs.js.map

package/dist/esm/Graphs.js.map

@@ -1 +1 @@
-{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAQ,QAAQ,EAAE,MAAM,cAAc,CAAC;AAapD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,MAAO,SAAQ,IAAI;IAC9B,YAAY,MAAmB;QAC7B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAE5D,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,SAAS;YACT,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;IACL,CAAC;IAmBY,KAAK,CAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAoB;;YAC9D,OAAO,IAAI,CAAC,SAAS,CAAW;gBAC9B,IAAI,EAAE;oBACJ,KAAK;oBACL,MAAM;iBACP;gBACD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,KAAK,QAAQ;aAC/B,CAAC,CAAC;QACL,CAAC;KAAA;IASY,UAAU,CAAC,IAAa;;YACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAqB;gBACpD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,QAAQ;gBACf,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7B,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAQ,IAAI,CAAC,CAAC;QAC/B,CAAC;KAAA;IASY,YAAY,CAAC,IAAY;;YACpC,OAAO,IAAI,CAAC,SAAS,CAAY;gBAC/B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,IAAI,EAAE;aACxB,CAAC,CAAC;QACL,CAAC;KAAA;IAWY,WAAW,CAAC,KAAY;;YACnC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,QAAQ;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAWY,WAAW,CAAC,KAAY;;YACnC,MAAM,EAAE,IAAI,KAAc,KAAK,EAAd,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAQ,CAAC;YAEhC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,KAAK,EAAE,UAAU,IAAI,EAAE;gBACvB,MAAM,EAAE,KAAK;gBACb,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;IASY,WAAW,CAAC,IAAY;;YACnC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,UAAU,IAAI,EAAE;aACxB,CAAC,CAAC;QACL,CAAC;KAAA;IAQY,SAAS,CAAC,KAAa,EAAE,EAAyB;YAAzB,EAAE,IAAI,OAAmB,EAAd,KAAK,cAAhB,QAAkB,CAAF;;YACpD,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;gBACxC,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;;KACJ;IAUY,WAAW,CAAC,KAAa,EAAE,IAAa;;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAsB;gBACxD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,UAAU;gBAChC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7B,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAQ,OAAO,CAAC,CAAC;QAClC,CAAC;KAAA;IAUY,QAAQ,CAAC,KAAa,EAAE,IAAY;;YAC/C,OAAO,IAAI,CAAC,SAAS,CAAQ;gBAC3B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;KAAA;IAUY,WAAW,CAAC,KAAa,EAAE,IAAY;;YAClD,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;KAAA;CACF"}
+{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAQ,QAAQ,EAAE,MAAM,cAAc,CAAC;AAapD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,MAAM,OAAO,MAAO,SAAQ,IAAI;IAC9B,YAAY,MAAmB;QAC7B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAE5D,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,SAAS;YACT,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;IACL,CAAC;IAmBY,KAAK,CAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAoB;;YAC9D,OAAO,IAAI,CAAC,SAAS,CAAW;gBAC9B,IAAI,EAAE;oBACJ,KAAK;oBACL,MAAM;iBACP;gBACD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,KAAK,QAAQ;aAC/B,CAAC,CAAC;QACL,CAAC;KAAA;IASY,UAAU,CAAC,IAAa;;YACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAqB;gBACpD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,QAAQ;gBACf,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7B,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAQ,IAAI,CAAC,CAAC;QAC/B,CAAC;KAAA;IASY,YAAY,CAAC,IAAY;;YACpC,OAAO,IAAI,CAAC,SAAS,CAAY;gBAC/B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,IAAI,EAAE;aACxB,CAAC,CAAC;QACL,CAAC;KAAA;IAWY,WAAW,CAAC,KAAY;;YACnC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,QAAQ;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAWY,WAAW,CAAC,KAAY;;YACnC,MAAM,EAAE,IAAI,KAAc,KAAK,EAAd,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAQ,CAAC;YAEhC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,KAAK,EAAE,UAAU,IAAI,EAAE;gBACvB,MAAM,EAAE,KAAK;gBACb,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;IASY,WAAW,CAAC,IAAY;;YACnC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,UAAU,IAAI,EAAE;aACxB,CAAC,CAAC;QACL,CAAC;KAAA;IAQY,SAAS,CAAC,KAAa,EAAE,EAAyB;YAAzB,EAAE,IAAI,OAAmB,EAAd,KAAK,cAAhB,QAAkB,CAAF;;YACpD,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;gBACxC,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;;KACJ;IAUY,WAAW,CAAC,KAAa,EAAE,IAAa;;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAsB;gBACxD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,UAAU;gBAChC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7B,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAQ,OAAO,CAAC,CAAC;QAClC,CAAC;KAAA;IAUY,QAAQ,CAAC,KAAa,EAAE,IAAY;;YAC/C,OAAO,IAAI,CAAC,SAAS,CAAQ;gBAC3B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;KAAA;IAUY,WAAW,CAAC,KAAa,EAAE,IAAY;;YAClD,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;KAAA;IAcY,YAAY,CAAC,KAAa,EAAE,IAAY;;YACnD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAqB;gBACzD,IAAI,EAAE,EAAE,IAAI,EAAE;gBACd,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,KAAK,iBAAiB;aACxC,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;CACF"}

package/dist/types/Graphs.d.ts

@@ -12,5 +12,6 @@ export declare class Graphs extends Base {
     listQueries(graph: string, name?: string): Promise<List<Query>>;
     getQuery(graph: string, name: string): Promise<Query>;
     deleteQuery(graph: string, name: string): Promise<WriteResponse>;
+    textToCypher(graph: string, text: string): Promise<string>;
 }
 //# sourceMappingURL=Graphs.d.ts.map

package/dist/types/Graphs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Graphs.d.ts","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAEpD,OAAO,EACL,aAAa,EACb,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,WAAW,EAEX,KAAK,EAEN,MAAM,SAAS,CAAC;AAIjB,qBAAa,MAAO,SAAQ,IAAI;gBAClB,MAAM,EAAE,WAAW;IA6BlB,KAAK,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,gBAAgB;IAkBnD,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAiB/C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAgB9C,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBjD,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBjD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAajD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,KAAK;IAgBlD,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAkBxC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAepC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;CAM9E"}
+{"version":3,"file":"Graphs.d.ts","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAEpD,OAAO,EACL,aAAa,EACb,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,WAAW,EAEX,KAAK,EAEN,MAAM,SAAS,CAAC;AAIjB,qBAAa,MAAO,SAAQ,IAAI;gBAClB,MAAM,EAAE,WAAW;IA6BlB,KAAK,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,gBAAgB;IAkBnD,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAiB/C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAgB9C,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBjD,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBjD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAajD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,KAAK;IAgBlD,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAkBxC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAepC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAmBhE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CASxE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/graph",
-  "version": "1.3.2",
+  "version": "1.4.0-beta.1448.0",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
@@ -27,6 +27,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "eba5a8ffb828bd4e8888216aff585f98922c859d"
+  }
 }

package/src/Graphs.ts

@@ -196,4 +196,26 @@ export class Graphs extends Base {
       route: `graphs/${graph}/queries/${name}`,
     });
   }
+
+  /**
+   * Converts user provided message to executable cypher query.
+   * @param {string} graph Graph name
+   * @param {string} text Text to generate a Cypher query from
+   * @returns {Promise<string>} Promise that resolves to the generated Cypher query
+   *
+   * ```typescript
+   * const generatedCypher = await graph.textToCypher('my-graph', 'List all airports in London');
+   * console.log(generatedCypher);
+   * // MATCH (n:Airport) WHERE n.city = 'London' RETURN n
+   * ```
+   */
+  public async textToCypher(graph: string, text: string): Promise<string> {
+    const { query } = await this.callApiV2<{ query: string; }>({
+      data: { text },
+      method: 'POST',
+      route: `graphs/${graph}/text-to-cypher`,
+    });
+
+    return query;
+  }
 }