feat: conversation and tool options

Signed-off-by: Dan Selman <danscode@selman.org>

README.md

@@ -152,7 +152,12 @@ you to ask follow-up questions. This capability exposes the GraphModel as an Ope
 allowing the LLM to call into the GraphModel to answer questions.
 
 ```typescript
-      const convo = new Conversation(graphModel);
+      const convo = new Conversation(graphModel, {
+        toolOptions: {
+          getById: true,
+          chatWithData: true
+        }
+      });      
       let result = await convo.appendUserMessage('Tell me a joke about actors');
       console.log(result);
       result = await convo.appendUserMessage('Which actor acted in Fear and Loathing in Las Vegas?');

docs/README.md

@@ -12,6 +12,7 @@
 ## Type Aliases
 
 - [Context](type-aliases/Context.md)
+- [ConversationOptions](type-aliases/ConversationOptions.md)
 - [EmbeddingCacheNode](type-aliases/EmbeddingCacheNode.md)
 - [EmbeddingFunction](type-aliases/EmbeddingFunction.md)
 - [FullTextIndex](type-aliases/FullTextIndex.md)
@@ -20,6 +21,7 @@
 - [Logger](type-aliases/Logger.md)
 - [PropertyBag](type-aliases/PropertyBag.md)
 - [SimilarityResult](type-aliases/SimilarityResult.md)
+- [ToolOptions](type-aliases/ToolOptions.md)
 - [ToolResponse](type-aliases/ToolResponse.md)
 - [VectorIndex](type-aliases/VectorIndex.md)
 

docs/classes/Conversation.md

@@ -12,7 +12,7 @@ An LLM conversation about a GraphModel
 
 ### new Conversation()
 
-> **new Conversation**(`graphModel`): [`Conversation`](Conversation.md)
+> **new Conversation**(`graphModel`, `options`): [`Conversation`](Conversation.md)
 
 Creates a new Conversation
 
@@ -21,14 +21,15 @@ Creates a new Conversation
 | Parameter | Type | Description |
 | :------ | :------ | :------ |
 | `graphModel` | [`GraphModel`](GraphModel.md) | the graph model for the conversation |
+| `options` | [`ConversationOptions`](../type-aliases/ConversationOptions.md) | - |
 
 #### Returns
 
 [`Conversation`](Conversation.md)
 
 #### Source
 
-[Conversation.ts:22](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/Conversation.ts#L22)
+[Conversation.ts:23](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/Conversation.ts#L23)
 
 ## Properties
 
@@ -63,4 +64,4 @@ the final result message
 
 #### Source
 
-[Conversation.ts:35](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/Conversation.ts#L35)
+[Conversation.ts:36](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/Conversation.ts#L36)

docs/classes/GraphModel.md

@@ -31,7 +31,7 @@ Creates a new instance of GraphModel
 
 #### Source
 
-[graphmodel.ts:24](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L24)
+[graphmodel.ts:24](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L24)
 
 ## Properties
 
@@ -65,7 +65,7 @@ the query results
 
 #### Source
 
-[graphmodel.ts:493](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L493)
+[graphmodel.ts:493](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L493)
 
 ***
 
@@ -87,7 +87,7 @@ Closes a database context.
 
 #### Source
 
-[graphmodel.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L67)
+[graphmodel.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L67)
 
 ***
 
@@ -103,7 +103,7 @@ Connects to Neo4J
 
 #### Source
 
-[graphmodel.ts:38](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L38)
+[graphmodel.ts:38](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L38)
 
 ***
 
@@ -119,7 +119,7 @@ Create Neo4J constraints for the model
 
 #### Source
 
-[graphmodel.ts:199](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L199)
+[graphmodel.ts:199](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L199)
 
 ***
 
@@ -135,7 +135,7 @@ Create fulltext indexes for the model
 
 #### Source
 
-[graphmodel.ts:269](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L269)
+[graphmodel.ts:269](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L269)
 
 ***
 
@@ -152,7 +152,7 @@ for the model
 
 #### Source
 
-[graphmodel.ts:190](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L190)
+[graphmodel.ts:190](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L190)
 
 ***
 
@@ -168,7 +168,7 @@ Create vector indexes for the model
 
 #### Source
 
-[graphmodel.ts:251](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L251)
+[graphmodel.ts:251](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L251)
 
 ***
 
@@ -184,7 +184,7 @@ Delete all nodes/edges in the graph
 
 #### Source
 
-[graphmodel.ts:287](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L287)
+[graphmodel.ts:287](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L287)
 
 ***
 
@@ -210,7 +210,7 @@ the result
 
 #### Source
 
-[graphmodel.ts:384](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L384)
+[graphmodel.ts:384](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L384)
 
 ***
 
@@ -226,7 +226,7 @@ Drop all Neo4J indexes for the model.
 
 #### Source
 
-[graphmodel.ts:161](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L161)
+[graphmodel.ts:161](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L161)
 
 ***
 
@@ -252,7 +252,7 @@ the items
 
 #### Source
 
-[graphmodel.ts:525](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L525)
+[graphmodel.ts:525](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L525)
 
 ***
 
@@ -268,16 +268,22 @@ Get all the full text indexes for the model
 
 #### Source
 
-[graphmodel.ts:234](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L234)
+[graphmodel.ts:234](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L234)
 
 ***
 
 ### getTools()
 
-> **getTools**(): `RunnableToolFunction`\<`any`\>[]
+> **getTools**(`options`): `RunnableToolFunction`\<`any`\>[]
 
 Creates OpenAI tools for the model
 
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `options` | [`ToolOptions`](../type-aliases/ToolOptions.md) |
+
 #### Returns
 
 `RunnableToolFunction`\<`any`\>[]
@@ -286,7 +292,7 @@ an array of OpenAI tool definitions
 
 #### Source
 
-[graphmodel.ts:617](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L617)
+[graphmodel.ts:617](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L617)
 
 ***
 
@@ -302,7 +308,7 @@ Get all the vector indexes for the model
 
 #### Source
 
-[graphmodel.ts:216](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L216)
+[graphmodel.ts:216](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L216)
 
 ***
 
@@ -331,7 +337,7 @@ the graph node
 
 #### Source
 
-[graphmodel.ts:361](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L361)
+[graphmodel.ts:361](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L361)
 
 ***
 
@@ -360,7 +366,7 @@ the source node
 
 #### Source
 
-[graphmodel.ts:399](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L399)
+[graphmodel.ts:399](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L399)
 
 ***
 
@@ -385,7 +391,7 @@ a promise to a Context for the database.
 
 #### Source
 
-[graphmodel.ts:55](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L55)
+[graphmodel.ts:55](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L55)
 
 ***
 
@@ -411,7 +417,7 @@ the query results
 
 #### Source
 
-[graphmodel.ts:334](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L334)
+[graphmodel.ts:334](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L334)
 
 ***
 
@@ -438,7 +444,7 @@ an array of similar nodes, up to the count limit
 
 #### Source
 
-[graphmodel.ts:458](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L458)
+[graphmodel.ts:458](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L458)
 
 ***
 
@@ -463,7 +469,7 @@ Performs a similarity search on nodes with text content
 
 #### Source
 
-[graphmodel.ts:303](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L303)
+[graphmodel.ts:303](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L303)
 
 ***
 
@@ -487,4 +493,4 @@ the Cypher query
 
 #### Source
 
-[graphmodel.ts:482](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/graphmodel.ts#L482)
+[graphmodel.ts:482](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L482)

docs/functions/getOpenAiEmbedding.md

@@ -25,4 +25,4 @@ a promise to an array of numbers
 
 ## Source
 
-[functions.ts:12](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/functions.ts#L12)
+[functions.ts:12](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/functions.ts#L12)

docs/type-aliases/Context.md

@@ -18,4 +18,4 @@ Runtime context
 
 ## Source
 
-[types.ts:34](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L34)
+[types.ts:60](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L60)

docs/type-aliases/ConversationOptions.md

@@ -0,0 +1,19 @@
+[**@accordproject/concerto-graph**](../README.md) • **Docs**
+
+***
+
+[@accordproject/concerto-graph](../README.md) / ConversationOptions
+
+# Type alias: ConversationOptions
+
+> **ConversationOptions**: `object`
+
+## Type declaration
+
+### toolOptions
+
+> **toolOptions**: [`ToolOptions`](ToolOptions.md)
+
+## Source
+
+[types.ts:44](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L44)

docs/type-aliases/EmbeddingCacheNode.md

@@ -26,4 +26,4 @@ A Node type that is used to cache vector embeddings
 
 ## Source
 
-[types.ts:41](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L41)
+[types.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L67)

docs/type-aliases/EmbeddingFunction.md

@@ -23,4 +23,4 @@ vector embeddings for text
 
 ## Source
 
-[types.ts:70](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L70)
+[types.ts:96](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L96)

docs/type-aliases/FullTextIndex.md

@@ -26,4 +26,4 @@ Definition of a full text index over some properties
 
 ## Source
 
-[types.ts:25](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L25)
+[types.ts:51](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L51)

docs/type-aliases/GraphModelOptions.md

@@ -38,4 +38,4 @@ Graph model options, used to configure Concerto Graph
 
 ## Source
 
-[types.ts:91](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L91)
+[types.ts:117](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L117)

docs/type-aliases/GraphNodeProperties.md

@@ -12,4 +12,4 @@ The properties allowed on graph nodes
 
 ## Source
 
-[types.ts:64](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L64)
+[types.ts:90](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L90)

docs/type-aliases/Logger.md

@@ -89,4 +89,4 @@ Function signature for a logger
 
 ## Source
 
-[types.ts:75](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L75)
+[types.ts:101](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L101)

docs/type-aliases/PropertyBag.md

@@ -12,4 +12,4 @@ A untyped set of properties
 
 ## Source
 
-[types.ts:59](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L59)
+[types.ts:85](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L85)

docs/type-aliases/SimilarityResult.md

@@ -26,4 +26,4 @@ Result of a vector similarity search
 
 ## Source
 
-[types.ts:50](https://github.com/accordproject/lab-concerto-graph/blob/d7fad90b4d14f7e274bc7920a0b495fb75c52dcc/src/types.ts#L50)
+[types.ts:76](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L76)

docs/type-aliases/ToolOptions.md

@@ -0,0 +1,41 @@
+[**@accordproject/concerto-graph**](../README.md) • **Docs**
+
+***
+
+[@accordproject/concerto-graph](../README.md) / ToolOptions
+
+# Type alias: ToolOptions
+
+> **ToolOptions**: `object`
+
+Options for tool generation from the model
+
+## Type declaration
+
+### chatWithData?
+
+> `optional` **chatWithData**: `boolean`
+
+Creates tools to retrieve nodes via generation of Cypher from natural language
+
+### fullTextSearch?
+
+> `optional` **fullTextSearch**: `boolean`
+
+Creates tools to retrieve nodes via fulltext search of indexed properties
+
+### getById?
+
+> `optional` **getById**: `boolean`
+
+Creates tools to retrieve nodes by id
+
+### similaritySearch?
+
+> `optional` **similaritySearch**: `boolean`
+
+Creates tools to retrieve nodes via similarity search of vector indexed properties
+
+## Source
+
+[types.ts:25](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L25)