Skip to content

Commit

Permalink
feat: options.textToGraphPrompt
Browse files Browse the repository at this point in the history
Signed-off-by: Dan Selman <danscode@selman.org>
  • Loading branch information
dselman committed Jun 27, 2024
1 parent c86669a commit f4094bb
Show file tree
Hide file tree
Showing 25 changed files with 65 additions and 58 deletions.
10 changes: 5 additions & 5 deletions docs/classes/Conversation.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Creates a new Conversation

#### Source

[Conversation.ts:26](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/Conversation.ts#L26)
[Conversation.ts:26](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/Conversation.ts#L26)

## Properties

Expand Down Expand Up @@ -65,7 +65,7 @@ the final result message

#### Source

[Conversation.ts:81](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/Conversation.ts#L81)
[Conversation.ts:81](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/Conversation.ts#L81)

***

Expand All @@ -91,7 +91,7 @@ the system message for the conversation
#### Source

[Conversation.ts:68](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/Conversation.ts#L68)
[Conversation.ts:68](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/Conversation.ts#L68)

***

Expand All @@ -110,7 +110,7 @@ or undefined if a user message has not been added

#### Source

[Conversation.ts:111](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/Conversation.ts#L111)
[Conversation.ts:111](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/Conversation.ts#L111)

***

Expand All @@ -136,4 +136,4 @@ all the messages

#### Source

[Conversation.ts:41](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/Conversation.ts#L41)
[Conversation.ts:41](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/Conversation.ts#L41)
60 changes: 30 additions & 30 deletions docs/classes/GraphModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Creates a new instance of GraphModel

#### Source

[graphmodel.ts:26](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L26)
[graphmodel.ts:26](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L26)

## Properties

Expand Down Expand Up @@ -65,7 +65,7 @@ the query results

#### Source

[graphmodel.ts:662](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L662)
[graphmodel.ts:662](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L662)

***

Expand All @@ -87,7 +87,7 @@ Closes a database context.

#### Source

[graphmodel.ts:166](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L166)
[graphmodel.ts:166](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L166)

***

Expand All @@ -103,7 +103,7 @@ Connects to Neo4J

#### Source

[graphmodel.ts:42](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L42)
[graphmodel.ts:42](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L42)

***

Expand All @@ -119,7 +119,7 @@ Create Neo4J constraints for the model

#### Source

[graphmodel.ts:300](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L300)
[graphmodel.ts:300](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L300)

***

Expand All @@ -135,7 +135,7 @@ Create fulltext indexes for the model

#### Source

[graphmodel.ts:372](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L372)
[graphmodel.ts:372](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L372)

***

Expand All @@ -152,7 +152,7 @@ for the model

#### Source

[graphmodel.ts:291](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L291)
[graphmodel.ts:291](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L291)

***

Expand All @@ -168,7 +168,7 @@ Create vector indexes for the model

#### Source

[graphmodel.ts:354](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L354)
[graphmodel.ts:354](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L354)

***

Expand All @@ -184,7 +184,7 @@ Delete all nodes/edges in the graph

#### Source

[graphmodel.ts:390](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L390)
[graphmodel.ts:390](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L390)

***

Expand All @@ -210,7 +210,7 @@ the result

#### Source

[graphmodel.ts:490](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L490)
[graphmodel.ts:490](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L490)

***

Expand All @@ -226,7 +226,7 @@ Drop all Neo4J indexes for the model.

#### Source

[graphmodel.ts:262](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L262)
[graphmodel.ts:262](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L262)

***

Expand All @@ -252,7 +252,7 @@ the items

#### Source

[graphmodel.ts:696](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L696)
[graphmodel.ts:696](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L696)

***

Expand All @@ -270,7 +270,7 @@ the concerto models as a string

#### Source

[graphmodel.ts:589](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L589)
[graphmodel.ts:589](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L589)

***

Expand All @@ -296,7 +296,7 @@ specified

#### Source

[graphmodel.ts:74](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L74)
[graphmodel.ts:74](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L74)

***

Expand All @@ -322,7 +322,7 @@ decorator

#### Source

[graphmodel.ts:337](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L337)
[graphmodel.ts:337](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L337)

***

Expand All @@ -343,7 +343,7 @@ graph nodes

#### Source

[graphmodel.ts:96](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L96)
[graphmodel.ts:96](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L96)

***

Expand All @@ -367,7 +367,7 @@ an array of OpenAI tool definitions

#### Source

[graphmodel.ts:790](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L790)
[graphmodel.ts:790](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L790)

***

Expand All @@ -393,7 +393,7 @@ decorator

#### Source

[graphmodel.ts:318](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L318)
[graphmodel.ts:318](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L318)

***

Expand All @@ -410,7 +410,7 @@ from the graph and populates the ModelManager

#### Source

[graphmodel.ts:149](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L149)
[graphmodel.ts:149](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L149)

***

Expand All @@ -428,7 +428,7 @@ promise to indicate the operation is complete

#### Source

[graphmodel.ts:116](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L116)
[graphmodel.ts:116](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L116)

***

Expand Down Expand Up @@ -457,7 +457,7 @@ the graph node

#### Source

[graphmodel.ts:467](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L467)
[graphmodel.ts:467](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L467)

***

Expand Down Expand Up @@ -486,7 +486,7 @@ the source node

#### Source

[graphmodel.ts:505](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L505)
[graphmodel.ts:505](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L505)

***

Expand All @@ -508,7 +508,7 @@ Converts a natural language block to a set of graph nodes/edges and adds them to

#### Source

[graphmodel.ts:615](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L615)
[graphmodel.ts:615](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L615)

***

Expand All @@ -533,7 +533,7 @@ a promise to a Context for the database.

#### Source

[graphmodel.ts:58](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L58)
[graphmodel.ts:58](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L58)

***

Expand All @@ -559,7 +559,7 @@ the query results

#### Source

[graphmodel.ts:437](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L437)
[graphmodel.ts:437](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L437)

***

Expand All @@ -578,7 +578,7 @@ returns the concerto model from the graph

#### Source

[graphmodel.ts:131](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L131)
[graphmodel.ts:131](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L131)

***

Expand All @@ -605,7 +605,7 @@ an array of similar nodes, up to the count limit

#### Source

[graphmodel.ts:564](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L564)
[graphmodel.ts:564](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L564)

***

Expand All @@ -630,7 +630,7 @@ Performs a similarity search on nodes with text content

#### Source

[graphmodel.ts:406](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L406)
[graphmodel.ts:406](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L406)

***

Expand All @@ -654,7 +654,7 @@ the Cypher query

#### Source

[graphmodel.ts:598](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L598)
[graphmodel.ts:598](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L598)

***

Expand All @@ -678,4 +678,4 @@ the graph nodes/edges

#### Source

[graphmodel.ts:607](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/graphmodel.ts#L607)
[graphmodel.ts:607](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/graphmodel.ts#L607)
2 changes: 1 addition & 1 deletion docs/functions/getOpenAiEmbedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ a promise to an array of numbers

## Source

[functions.ts:12](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/functions.ts#L12)
[functions.ts:12](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/functions.ts#L12)
2 changes: 1 addition & 1 deletion docs/type-aliases/Context.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ Runtime context
## Source

[types.ts:133](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L133)
[types.ts:133](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L133)
2 changes: 1 addition & 1 deletion docs/type-aliases/ConversationOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Which tools to register on the conversation

## Source

[types.ts:97](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L97)
[types.ts:97](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L97)
2 changes: 1 addition & 1 deletion docs/type-aliases/EmbeddingCacheNode.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ A Node type that is used to cache vector embeddings
## Source

[types.ts:140](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L140)
[types.ts:140](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L140)
2 changes: 1 addition & 1 deletion docs/type-aliases/EmbeddingFunction.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ vector embeddings for text

## Source

[types.ts:169](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L169)
[types.ts:169](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L169)
2 changes: 1 addition & 1 deletion docs/type-aliases/FullTextIndex.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Definition of a full text index over some properties
## Source

[types.ts:124](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L124)
[types.ts:124](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L124)
6 changes: 5 additions & 1 deletion docs/type-aliases/GraphModelOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ Graph model options, used to configure Concerto Graph
Options to configure Open AI

### textToGraphPrompt?

> `optional` **textToGraphPrompt**: `string`
## Source

[types.ts:190](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L190)
[types.ts:190](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L190)
2 changes: 1 addition & 1 deletion docs/type-aliases/GraphNodeProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ The properties allowed on graph nodes

## Source

[types.ts:163](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L163)
[types.ts:163](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L163)
2 changes: 1 addition & 1 deletion docs/type-aliases/Logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@ Function signature for a logger

## Source

[types.ts:174](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L174)
[types.ts:174](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L174)
2 changes: 1 addition & 1 deletion docs/type-aliases/OpenAiOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ Tool choice

## Source

[types.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L67)
[types.ts:67](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L67)
2 changes: 1 addition & 1 deletion docs/type-aliases/PropertyBag.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ A untyped set of properties

## Source

[types.ts:158](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L158)
[types.ts:158](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L158)
2 changes: 1 addition & 1 deletion docs/type-aliases/SimilarityResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Result of a vector similarity search
## Source

[types.ts:149](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L149)
[types.ts:149](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L149)
2 changes: 1 addition & 1 deletion docs/type-aliases/TextToGraphElement.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
## Source

[types.ts:40](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L40)
[types.ts:40](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L40)
2 changes: 1 addition & 1 deletion docs/type-aliases/TextToGraphNode.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@
## Source

[types.ts:25](https://github.com/accordproject/lab-concerto-graph/blob/5f526300879649c63bb20f7c002e7b5dd5cd22c3/src/types.ts#L25)
[types.ts:25](https://github.com/accordproject/lab-concerto-graph/blob/c86669a10a27298cd56667820f64e9064b866591/src/types.ts#L25)
Loading

0 comments on commit f4094bb

Please sign in to comment.