From 4f9bc9d221981b215096d0e5223994bc8c2351f5 Mon Sep 17 00:00:00 2001 From: Dan Selman Date: Tue, 28 May 2024 14:56:15 +0100 Subject: [PATCH] docs Signed-off-by: Dan Selman --- docs/classes/Conversation.md | 4 +-- docs/classes/GraphModel.md | 44 ++++++++++++------------ docs/functions/getOpenAiEmbedding.md | 2 +- docs/type-aliases/Context.md | 2 +- docs/type-aliases/ConversationOptions.md | 2 +- docs/type-aliases/EmbeddingCacheNode.md | 2 +- docs/type-aliases/EmbeddingFunction.md | 2 +- docs/type-aliases/FullTextIndex.md | 2 +- docs/type-aliases/GraphModelOptions.md | 2 +- docs/type-aliases/GraphNodeProperties.md | 2 +- docs/type-aliases/Logger.md | 2 +- docs/type-aliases/PropertyBag.md | 2 +- docs/type-aliases/SimilarityResult.md | 2 +- docs/type-aliases/ToolOptions.md | 2 +- docs/type-aliases/ToolResponse.md | 2 +- docs/type-aliases/VectorIndex.md | 2 +- docs/variables/ConsoleLogger.md | 2 +- docs/variables/EMBEDDINGS_MAGIC.md | 2 +- 18 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/classes/Conversation.md b/docs/classes/Conversation.md index a755516..d1f60be 100644 --- a/docs/classes/Conversation.md +++ b/docs/classes/Conversation.md @@ -29,7 +29,7 @@ Creates a new Conversation #### Source -[Conversation.ts:23](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/Conversation.ts#L23) +[Conversation.ts:23](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/Conversation.ts#L23) ## Properties @@ -64,4 +64,4 @@ the final result message #### Source -[Conversation.ts:36](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/Conversation.ts#L36) +[Conversation.ts:36](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/Conversation.ts#L36) diff --git a/docs/classes/GraphModel.md b/docs/classes/GraphModel.md index c4af80a..6bda19a 100644 --- a/docs/classes/GraphModel.md +++ b/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L24) +[graphmodel.ts:24](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L24) ## Properties @@ -65,7 +65,7 @@ the query results #### Source -[graphmodel.ts:493](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L493) +[graphmodel.ts:493](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L493) *** @@ -87,7 +87,7 @@ Closes a database context. #### Source -[graphmodel.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L67) +[graphmodel.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L67) *** @@ -103,7 +103,7 @@ Connects to Neo4J #### Source -[graphmodel.ts:38](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L38) +[graphmodel.ts:38](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L199) +[graphmodel.ts:199](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L269) +[graphmodel.ts:269](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L269) *** @@ -152,7 +152,7 @@ for the model #### Source -[graphmodel.ts:190](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L190) +[graphmodel.ts:190](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L251) +[graphmodel.ts:251](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L287) +[graphmodel.ts:287](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L287) *** @@ -210,7 +210,7 @@ the result #### Source -[graphmodel.ts:384](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L384) +[graphmodel.ts:384](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L161) +[graphmodel.ts:161](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L161) *** @@ -252,7 +252,7 @@ the items #### Source -[graphmodel.ts:525](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L525) +[graphmodel.ts:525](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L525) *** @@ -268,7 +268,7 @@ Get all the full text indexes for the model #### Source -[graphmodel.ts:234](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L234) +[graphmodel.ts:234](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L234) *** @@ -292,7 +292,7 @@ an array of OpenAI tool definitions #### Source -[graphmodel.ts:617](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L617) +[graphmodel.ts:617](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L617) *** @@ -308,7 +308,7 @@ Get all the vector indexes for the model #### Source -[graphmodel.ts:216](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L216) +[graphmodel.ts:216](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L216) *** @@ -337,7 +337,7 @@ the graph node #### Source -[graphmodel.ts:361](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L361) +[graphmodel.ts:361](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L361) *** @@ -366,7 +366,7 @@ the source node #### Source -[graphmodel.ts:399](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L399) +[graphmodel.ts:399](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L399) *** @@ -391,7 +391,7 @@ a promise to a Context for the database. #### Source -[graphmodel.ts:55](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L55) +[graphmodel.ts:55](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L55) *** @@ -417,7 +417,7 @@ the query results #### Source -[graphmodel.ts:334](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L334) +[graphmodel.ts:334](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L334) *** @@ -444,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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L458) +[graphmodel.ts:458](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L458) *** @@ -469,7 +469,7 @@ Performs a similarity search on nodes with text content #### Source -[graphmodel.ts:303](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L303) +[graphmodel.ts:303](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L303) *** @@ -493,4 +493,4 @@ the Cypher query #### Source -[graphmodel.ts:482](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/graphmodel.ts#L482) +[graphmodel.ts:482](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/graphmodel.ts#L482) diff --git a/docs/functions/getOpenAiEmbedding.md b/docs/functions/getOpenAiEmbedding.md index f7c6b50..0a9206a 100644 --- a/docs/functions/getOpenAiEmbedding.md +++ b/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/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/functions.ts#L12) +[functions.ts:12](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/functions.ts#L12) diff --git a/docs/type-aliases/Context.md b/docs/type-aliases/Context.md index 5010b24..3e40fd5 100644 --- a/docs/type-aliases/Context.md +++ b/docs/type-aliases/Context.md @@ -18,4 +18,4 @@ Runtime context ## Source -[types.ts:60](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L60) +[types.ts:60](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L60) diff --git a/docs/type-aliases/ConversationOptions.md b/docs/type-aliases/ConversationOptions.md index c9101d3..5e1d2e8 100644 --- a/docs/type-aliases/ConversationOptions.md +++ b/docs/type-aliases/ConversationOptions.md @@ -16,4 +16,4 @@ ## Source -[types.ts:44](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L44) +[types.ts:44](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L44) diff --git a/docs/type-aliases/EmbeddingCacheNode.md b/docs/type-aliases/EmbeddingCacheNode.md index 8b7bc27..5833e80 100644 --- a/docs/type-aliases/EmbeddingCacheNode.md +++ b/docs/type-aliases/EmbeddingCacheNode.md @@ -26,4 +26,4 @@ A Node type that is used to cache vector embeddings ## Source -[types.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L67) +[types.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L67) diff --git a/docs/type-aliases/EmbeddingFunction.md b/docs/type-aliases/EmbeddingFunction.md index c920984..94fb945 100644 --- a/docs/type-aliases/EmbeddingFunction.md +++ b/docs/type-aliases/EmbeddingFunction.md @@ -23,4 +23,4 @@ vector embeddings for text ## Source -[types.ts:96](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L96) +[types.ts:96](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L96) diff --git a/docs/type-aliases/FullTextIndex.md b/docs/type-aliases/FullTextIndex.md index b7e9fa8..be82897 100644 --- a/docs/type-aliases/FullTextIndex.md +++ b/docs/type-aliases/FullTextIndex.md @@ -26,4 +26,4 @@ Definition of a full text index over some properties ## Source -[types.ts:51](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L51) +[types.ts:51](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L51) diff --git a/docs/type-aliases/GraphModelOptions.md b/docs/type-aliases/GraphModelOptions.md index 05cb6b0..3f29ec6 100644 --- a/docs/type-aliases/GraphModelOptions.md +++ b/docs/type-aliases/GraphModelOptions.md @@ -38,4 +38,4 @@ Graph model options, used to configure Concerto Graph ## Source -[types.ts:117](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L117) +[types.ts:117](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L117) diff --git a/docs/type-aliases/GraphNodeProperties.md b/docs/type-aliases/GraphNodeProperties.md index 4fef458..e68e60b 100644 --- a/docs/type-aliases/GraphNodeProperties.md +++ b/docs/type-aliases/GraphNodeProperties.md @@ -12,4 +12,4 @@ The properties allowed on graph nodes ## Source -[types.ts:90](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L90) +[types.ts:90](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L90) diff --git a/docs/type-aliases/Logger.md b/docs/type-aliases/Logger.md index 04196e8..220dfda 100644 --- a/docs/type-aliases/Logger.md +++ b/docs/type-aliases/Logger.md @@ -89,4 +89,4 @@ Function signature for a logger ## Source -[types.ts:101](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L101) +[types.ts:101](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L101) diff --git a/docs/type-aliases/PropertyBag.md b/docs/type-aliases/PropertyBag.md index cc929d7..777585f 100644 --- a/docs/type-aliases/PropertyBag.md +++ b/docs/type-aliases/PropertyBag.md @@ -12,4 +12,4 @@ A untyped set of properties ## Source -[types.ts:85](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L85) +[types.ts:85](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L85) diff --git a/docs/type-aliases/SimilarityResult.md b/docs/type-aliases/SimilarityResult.md index e6f12f0..90ed74a 100644 --- a/docs/type-aliases/SimilarityResult.md +++ b/docs/type-aliases/SimilarityResult.md @@ -26,4 +26,4 @@ Result of a vector similarity search ## Source -[types.ts:76](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L76) +[types.ts:76](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L76) diff --git a/docs/type-aliases/ToolOptions.md b/docs/type-aliases/ToolOptions.md index c182e4d..ffd64e6 100644 --- a/docs/type-aliases/ToolOptions.md +++ b/docs/type-aliases/ToolOptions.md @@ -38,4 +38,4 @@ Creates tools to retrieve nodes via similarity search of vector indexed properti ## Source -[types.ts:25](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L25) +[types.ts:25](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L25) diff --git a/docs/type-aliases/ToolResponse.md b/docs/type-aliases/ToolResponse.md index 1aa5ff3..15d2715 100644 --- a/docs/type-aliases/ToolResponse.md +++ b/docs/type-aliases/ToolResponse.md @@ -26,4 +26,4 @@ The string that we should compute embedding vectors for ## Source -[types.ts:129](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L129) +[types.ts:129](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L129) diff --git a/docs/type-aliases/VectorIndex.md b/docs/type-aliases/VectorIndex.md index 7094bc6..6941b39 100644 --- a/docs/type-aliases/VectorIndex.md +++ b/docs/type-aliases/VectorIndex.md @@ -34,4 +34,4 @@ Definition of a vector (embeddings) index ## Source -[types.ts:14](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L14) +[types.ts:14](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L14) diff --git a/docs/variables/ConsoleLogger.md b/docs/variables/ConsoleLogger.md index d8615f3..c58bf13 100644 --- a/docs/variables/ConsoleLogger.md +++ b/docs/variables/ConsoleLogger.md @@ -10,4 +10,4 @@ ## Source -[ConsoleLogger.ts:4](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/ConsoleLogger.ts#L4) +[ConsoleLogger.ts:4](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/ConsoleLogger.ts#L4) diff --git a/docs/variables/EMBEDDINGS_MAGIC.md b/docs/variables/EMBEDDINGS_MAGIC.md index 78b17e4..17b9e0f 100644 --- a/docs/variables/EMBEDDINGS_MAGIC.md +++ b/docs/variables/EMBEDDINGS_MAGIC.md @@ -14,4 +14,4 @@ that include semantic embeddings ## Source -[types.ts:9](https://github.com/accordproject/lab-concerto-graph/blob/8f4fb74348d19b37d903f29e81aaec4eca02a552/src/types.ts#L9) +[types.ts:9](https://github.com/accordproject/lab-concerto-graph/blob/d465c4dc872d480e4c8d94031fef52df36ff5b77/src/types.ts#L9)