Custom Configuration Mode
The primary configuration sections for Indexing Engine pipelines are described below. Each configuration section can be expressed in Python (for use in Python API mode) as well as YAML, but YAML is show here for brevity.
-Using custom configuration is an advanced use-case. Most users will want to use the Default Configuration instead.
+Using custom configuration is an advanced use-case. Most users will want to use the Default Configuration instead.
Indexing Engine Examples
The examples directory contains several examples of how to use the indexing engine with custom configuration.
Most examples include two different forms of running the pipeline, both are contained in the examples run.py
- -Architecture +Architecture
- -Overview +Dataflow
- -Overview -
- -Dataflow -
- -CLI +CLI
-
-Workflows
+Workflows
- -create_base_entity_graph +create_base_documents
- -create_final_covariates +create_final_communities
- -create_final_entities +create_final_community_reports
- -create_final_text_units +create_final_relationships
- -create_base_documents +create_summarized_entities
- -create_base_extracted_entities +create_base_entity_graph
- -create_base_text_units +create_base_extracted_entities
- -create_final_communities +create_base_text_units
- -create_final_documents +create_final_covariates
- -create_final_nodes +create_final_documents
- -create_final_relationships +create_final_entities
- -create_summarized_entities +create_final_nodes
- -create_final_community_reports +create_final_text_units
-
-Verbs
+Verbs
- -genid +genid
- -spread_json +spread_json
- -aggregate +unzip
- -concat +zip
- -merge +aggregate
- -unzip +concat
- -zip +merge
- -chunk +text_replace
- -text_replace +text_split
- -text_split +chunk
- -create_graph +create_graph
- -unpack_graph +unpack_graph
- -layout_graph +layout_graph
- -cluster_graph +merge_graphs
- -merge_graphs +cluster_graph
- -Configuration +Configuration @@ -276,26 +272,26 @@ p {
-
-Query
+Query
- -Global Search +Global Search
- -Local Search +Local Search
- -Question Generation +Question Generation
- -CLI +CLI
- -Notebooks +Notebooks diff --git a/_posts/_config/json_yaml/index.html b/posts/config/json_yaml/index.html similarity index 82% rename from _posts/_config/json_yaml/index.html rename to posts/config/json_yaml/index.html index a841bf12..2e5ba52d 100644 --- a/_posts/_config/json_yaml/index.html +++ b/posts/config/json_yaml/index.html @@ -161,111 +161,107 @@ p {
- -Get Started +Get Started -Developing +Developing
-
-Indexing
+Indexing
- -Architecture +Architecture
- -Overview +Dataflow
- -Overview -
- -Dataflow -
- -CLI +CLI
-
-Workflows
+Workflows
- -create_base_entity_graph +create_base_documents
- -create_final_covariates +create_final_communities
- -create_final_entities +create_final_community_reports
- -create_final_text_units +create_final_relationships
- -create_base_documents +create_summarized_entities
- -create_base_extracted_entities +create_base_entity_graph
- -create_base_text_units +create_base_extracted_entities
- -create_final_communities +create_base_text_units
- -create_final_documents +create_final_covariates
- -create_final_nodes +create_final_documents
- -create_final_relationships +create_final_entities
- -create_summarized_entities +create_final_nodes
- -create_final_community_reports +create_final_text_units
-
-Verbs
+Verbs
- -genid +genid
- -spread_json +spread_json
- -aggregate +unzip
- -concat +zip
- -merge +aggregate
- -unzip +concat
- -zip +merge
- -chunk +text_replace
- -text_replace +text_split
- -text_split +chunk
- -create_graph +create_graph
- -unpack_graph +unpack_graph
- -layout_graph +layout_graph
- -cluster_graph +merge_graphs
- -merge_graphs +cluster_graph
- -Configuration +Configuration @@ -276,26 +272,26 @@ p {
-
-Query
+Query
- -Global Search +Global Search
- -Local Search +Local Search
- -Question Generation +Question Generation
- -CLI +CLI
- -Notebooks +Notebooks diff --git a/_posts/_config/overview/index.html b/posts/config/overview/index.html similarity index 63% rename from _posts/_config/overview/index.html rename to posts/config/overview/index.html index 2bb3d720..8cf8a832 100644 --- a/_posts/_config/overview/index.html +++ b/posts/config/overview/index.html @@ -161,111 +161,107 @@ p {
- -Get Started +Get Started -Developing +Developing
-
-Indexing
+Indexing
- -Architecture +Architecture
- -Overview +Dataflow
- -Overview -
- -Dataflow -
- -CLI +CLI
-
-Workflows
+Workflows
- -create_base_entity_graph +create_base_documents
- -create_final_covariates +create_final_communities
- -create_final_entities +create_final_community_reports
- -create_final_text_units +create_final_relationships
- -create_base_documents +create_summarized_entities
- -create_base_extracted_entities +create_base_entity_graph
- -create_base_text_units +create_base_extracted_entities
- -create_final_communities +create_base_text_units
- -create_final_documents +create_final_covariates
- -create_final_nodes +create_final_documents
- -create_final_relationships +create_final_entities
- -create_summarized_entities +create_final_nodes
- -create_final_community_reports +create_final_text_units
-
-Verbs
+Verbs
- -genid +genid
- -spread_json +spread_json
- -aggregate +unzip
- -concat +zip
- -merge +aggregate
- -unzip +concat
- -zip +merge
- -chunk +text_replace
- -text_replace +text_split
- -text_split +chunk
- -create_graph +create_graph
- -unpack_graph +unpack_graph
- -layout_graph +layout_graph
- -cluster_graph +merge_graphs
- -merge_graphs +cluster_graph
- -Configuration +Configuration @@ -276,26 +272,26 @@ p {
-
-Query
+Query
- -Global Search +Global Search
- -Local Search +Local Search
- -Question Generation +Question Generation
- -CLI +CLI
- -Notebooks +Notebooks @@ -311,11 +307,11 @@ p {
- Purely using environment variables -
- Using JSON or YAML for deeper control +
- Purely using environment variables +
- Using JSON or YAML for deeper control
Default Configuration Mode
The default configuration mode is the simplest way to get started with the GraphRAG system. It is designed to work out-of-the-box with minimal configuration. The primary configuration sections for the Indexing Engine pipelines are described below. The main ways to set up GraphRAG in Default Configuration mode are via:
-
-
Custom Configuration Mode
-Custom configuration mode is an advanced use-case. Most users will want to use the Default Configuration instead. The primary configuration sections for Indexing Engine pipelines are described below. Details about how to use custom configuration are available in the Custom Configuration Mode documentation.
+Custom configuration mode is an advanced use-case. Most users will want to use the Default Configuration instead. The primary configuration sections for Indexing Engine pipelines are described below. Details about how to use custom configuration are available in the Custom Configuration Mode documentation.