Skip to content

Commit 9593e1f

Browse files
committed
Add config and table renames
1 parent 248496d commit 9593e1f

File tree

2 files changed

+15
-27
lines changed

2 files changed

+15
-27
lines changed

docs/config/yaml.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ models:
6666
- `parallelization_num_threads` **int** - The maximum number of work threads.
6767
- `async_mode` **asyncio|threaded** The async mode to use. Either `asyncio` or `threaded.
6868

69-
### embeddings
69+
### embed_text
7070

7171
By default, the GraphRAG indexer will only export embeddings required for our query methods. However, the model has embeddings defined for all plaintext fields, and these can be customized by setting the `target` and `names` fields.
7272

@@ -143,7 +143,7 @@ This section controls the cache mechanism used by the pipeline. This is used to
143143
- `base_dir` **str** - The base directory to write cache to, relative to the root.
144144
- `storage_account_blob_url` **str** - The storage account blob URL to use.
145145

146-
### storage
146+
### output
147147

148148
This section controls the storage mechanism used by the pipeline used for exporting output tables.
149149

@@ -179,7 +179,7 @@ This section controls the reporting mechanism used by the pipeline, for common e
179179
- `base_dir` **str** - The base directory to write reports to, relative to the root.
180180
- `storage_account_blob_url` **str** - The storage account blob URL to use.
181181

182-
### entity_extraction
182+
### extract_graph
183183

184184
#### Fields
185185

@@ -215,7 +215,7 @@ Defines settings for NLP-based graph extraction methods.
215215
- noun_phrase_tags **list[str]** - List of noun phrase tags to ignore.
216216
- noun_phrase_grammars **dict[str, str]** - Noun phrase grammars for the model (cfg-only).
217217

218-
### claim_extraction
218+
### extract_claims
219219

220220
#### Fields
221221

@@ -286,7 +286,6 @@ Indicates whether we should run UMAP dimensionality reduction. This is used to p
286286

287287
- `embeddings` **bool** - Export embeddings snapshots to parquet.
288288
- `graphml` **bool** - Export graph snapshots to GraphML.
289-
- `transient` **bool** - Export transient workflow tables snapshots to parquet.
290289

291290
## Query
292291

@@ -376,4 +375,4 @@ Indicates whether we should run UMAP dimensionality reduction. This is used to p
376375

377376
### workflows
378377

379-
**str** - This is a list of workflow names to run, in order. GraphRAG has built-in pipelines to configure this, but you can run exactly and only what you want by specifying the list here. Useful if you have done part of the processing yourself.
378+
**list[str]** - This is a list of workflow names to run, in order. GraphRAG has built-in pipelines to configure this, but you can run exactly and only what you want by specifying the list here. Useful if you have done part of the processing yourself.

docs/index/outputs.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ All tables have two identifier fields:
1010
| id | str | Generated UUID, assuring global uniqueness |
1111
| human_readable_id | int | This is an incremented short ID created per-run. For example, we use this short ID with generated summaries that print citations so they are easy to cross-reference visually. |
1212

13-
## create_final_communities
13+
## communities
1414
This is a list of the final communities generated by Leiden. Communities are strictly hierarchical, subdividing into children as the cluster affinity is narrowed.
1515

1616
| name | type | description |
@@ -25,7 +25,7 @@ This is a list of the final communities generated by Leiden. Communities are str
2525
| period | str | Date of ingest, used for incremental update merges. ISO8601 |
2626
| size | int | Size of the community (entity count), used for incremental update merges. |
2727

28-
## create_final_community_reports
28+
## community_reports
2929
This is the list of summarized reports for each community.
3030

3131
| name | type | description |
@@ -43,7 +43,7 @@ This is the list of summarized reports for each community.
4343
| period | str | Date of ingest, used for incremental update merges. ISO8601 |
4444
| size | int | Size of the community (entity count), used for incremental update merges. |
4545

46-
## create_final_covariates
46+
## covariates
4747
(Optional) If claim extraction is turned on, this is a list of the extracted covariates. Note that claims are typically oriented around identifying malicious behavior such as fraud, so they are not useful for all datasets.
4848

4949
| name | type | description |
@@ -59,7 +59,7 @@ This is the list of summarized reports for each community.
5959
| source_text | str | Short string of text containing the claimed behavior. |
6060
| text_unit_id | str | ID of the text unit the claim text was extracted from. |
6161

62-
## create_final_documents
62+
## documents
6363
List of document content after import.
6464

6565
| name | type | description |
@@ -69,7 +69,7 @@ List of document content after import.
6969
| text_unit_ids | str[] | List of text units (chunks) that were parsed from the document. |
7070
| metadata | dict | (optional) If specified during CSV import, this is a dict of metadata for the document. |
7171

72-
## create_final_entities
72+
## entities
7373
List of all entities found in the data by the LM.
7474

7575
| name | type | description |
@@ -78,22 +78,11 @@ List of all entities found in the data by the LM.
7878
| type | str | Type of the entity. By default this will be "organization", "person", "geo", or "event" unless configured differently or auto-tuning is used. |
7979
| description | str | Textual description of the entity. Entities may be found in many text units, so this is an LM-derived summary of all descriptions. |
8080
| text_unit_ids | str[] | List of the text units containing the entity. |
81+
| degree | int | Node degree (connectedness) in the graph. |
82+
| x | float | X position of the node for visual layouts. If graph embeddings and UMAP are not turned on, this will be 0. |
83+
| y | float | Y position of the node for visual layouts. If graph embeddings and UMAP are not turned on, this will be 0. |
8184

82-
## create_final_nodes
83-
This is graph-related information for the entities. It contains only information relevant to the graph such as community. There is an entry for each entity at every community level it is found within, so you may see "duplicate" entities.
84-
85-
Note that the ID fields match those in create_final_entities and can be used for joining if additional information about a node is required.
86-
87-
| name | type | description |
88-
| --------- | ----- | ----------- |
89-
| title | str | Name of the referenced entity. Duplicated from create_final_entities for convenient cross-referencing. |
90-
| community | int | Leiden community the node is found within. Entities are not always assigned a community (they may not be close enough to any), so they may have a ID of -1. |
91-
| level | int | Level of the community the entity is in. |
92-
| degree | int | Node degree (connectedness) in the graph. |
93-
| x | float | X position of the node for visual layouts. If graph embeddings and UMAP are not turned on, this will be 0. |
94-
| y | float | Y position of the node for visual layouts. If graph embeddings and UMAP are not turned on, this will be 0. |
95-
96-
## create_final_relationships
85+
## relationships
9786
List of all entity-to-entity relationships found in the data by the LM. This is also the _edge list_ for the graph.
9887

9988
| name | type | description |
@@ -105,7 +94,7 @@ List of all entity-to-entity relationships found in the data by the LM. This is
10594
| combined_degree | int | Sum of source and target node degrees. |
10695
| text_unit_ids | str[] | List of text units the relationship was found within. |
10796

108-
## create_final_text_units
97+
## text_units
10998
List of all text chunks parsed from the input documents.
11099

111100
| name | type | description |

0 commit comments

Comments
 (0)