From 3efddae502f51e887422d8fca0034a1af2e6f7a8 Mon Sep 17 00:00:00 2001 From: darthtrevino Date: Thu, 4 Apr 2024 19:46:42 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20microsof?= =?UTF-8?q?t/graphrag@fd54584008c5f739c257b8ff1b0f9aeb1902e852=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.html | 2 + posts/config/custom/index.html | 2 + posts/config/env_vars/index.html | 2 + posts/config/json_yaml/index.html | 2 + posts/config/overview/index.html | 2 + posts/developing/index.html | 2 + posts/get_started/index.html | 2 + posts/index/0-architecture/index.html | 2 + posts/index/1-default_dataflow/index.html | 2 + posts/index/2-cli/index.html | 2 + posts/index/3-prompt_tuning/index.html | 387 ++++++++++++++++++ posts/index/overview/index.html | 2 + posts/index/verbs/aggregate/index.html | 2 + posts/index/verbs/chunk/index.html | 2 + posts/index/verbs/cluster_graph/index.html | 2 + posts/index/verbs/concat/index.html | 2 + posts/index/verbs/create_graph/index.html | 2 + posts/index/verbs/genid/index.html | 2 + posts/index/verbs/layout_graph/index.html | 2 + posts/index/verbs/merge/index.html | 2 + posts/index/verbs/merge_graphs/index.html | 2 + posts/index/verbs/overview/index.html | 2 + posts/index/verbs/spread_json/index.html | 2 + posts/index/verbs/text_replace/index.html | 2 + posts/index/verbs/text_split/index.html | 2 + posts/index/verbs/unpack_graph/index.html | 2 + posts/index/verbs/unzip/index.html | 2 + posts/index/verbs/zip/index.html | 2 + .../create_base_documents/index.html | 2 + .../create_base_entity_graph/index.html | 2 + .../create_base_extracted_entities/index.html | 2 + .../create_base_text_units/index.html | 2 + .../create_final_communities/index.html | 2 + .../create_final_community_reports/index.html | 2 + .../create_final_covariates/index.html | 2 + .../create_final_documents/index.html | 2 + .../create_final_entities/index.html | 2 + .../workflows/create_final_nodes/index.html | 2 + .../create_final_relationships/index.html | 2 + .../create_final_text_units/index.html | 2 + .../create_summarized_entities/index.html | 2 + posts/index/workflows/overview/index.html | 2 + posts/query/0-global_search/index.html | 2 + posts/query/1-local_search/index.html | 2 + posts/query/2-question_generation/index.html | 2 + posts/query/3-cli/index.html | 2 + .../notebooks/global_search_nb/index.html | 2 + .../notebooks/local_search_nb/index.html | 2 + posts/query/notebooks/overview/index.html | 2 + posts/query/overview/index.html | 2 + 50 files changed, 485 insertions(+) create mode 100644 posts/index/3-prompt_tuning/index.html diff --git a/index.html b/index.html index 01fd9a66..91e5ca0d 100644 --- a/index.html +++ b/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/config/custom/index.html b/posts/config/custom/index.html index 1a541e2f..a293ea50 100644 --- a/posts/config/custom/index.html +++ b/posts/config/custom/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/config/env_vars/index.html b/posts/config/env_vars/index.html index 0386199e..dd1ddad8 100644 --- a/posts/config/env_vars/index.html +++ b/posts/config/env_vars/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/config/json_yaml/index.html b/posts/config/json_yaml/index.html index 008e648f..7fa6d0ad 100644 --- a/posts/config/json_yaml/index.html +++ b/posts/config/json_yaml/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/config/overview/index.html b/posts/config/overview/index.html index 8b8b01d4..243c8e1f 100644 --- a/posts/config/overview/index.html +++ b/posts/config/overview/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/developing/index.html b/posts/developing/index.html index 10eca983..b39293d7 100644 --- a/posts/developing/index.html +++ b/posts/developing/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/get_started/index.html b/posts/get_started/index.html index 401a307f..2def41e1 100644 --- a/posts/get_started/index.html +++ b/posts/get_started/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/0-architecture/index.html b/posts/index/0-architecture/index.html index b8dfdbf4..536d30e7 100644 --- a/posts/index/0-architecture/index.html +++ b/posts/index/0-architecture/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/1-default_dataflow/index.html b/posts/index/1-default_dataflow/index.html index d966f490..5c7ae67a 100644 --- a/posts/index/1-default_dataflow/index.html +++ b/posts/index/1-default_dataflow/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/2-cli/index.html b/posts/index/2-cli/index.html index 3b74c968..b8d2ec17 100644 --- a/posts/index/2-cli/index.html +++ b/posts/index/2-cli/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/3-prompt_tuning/index.html b/posts/index/3-prompt_tuning/index.html new file mode 100644 index 00000000..f76ce2b4 --- /dev/null +++ b/posts/index/3-prompt_tuning/index.html @@ -0,0 +1,387 @@ + + + + + + + + + + Prompt Tuning + + + + + + + + + + + + + + +
    + + GraphRAG +
    +
    + + + + +
    +

    Prompt Tuning

    +

    The GraphRAG indexer, by default, will run with a handful of prompts that are designed to work well in the broad context of knowledge discovery. +However, it is quite common to want to tune the prompts to better suit your specific use case. +We provide a means for you to do this by allowing you to specify a custom prompt file, which will each use a series of token-replacements internally.

    +

    Each of these prompts may be overridden by writing a custom prompt file in plaintext. We use token-replacements in the form of {token_name}, and the descriptions for the available tokens can be found below.

    +

    Entity/Relationship Extraction

    +

    Prompt Source

    +

    Tokens (values provided by extractor)

    +
      +
    • {input_text} - The input text to be processed.
      • +
    • {entity_types} - A list of entity types
      • +
    • {tuple_delimiter} - A delimiter for separating values within a tuple. A single tuple is used to represent an individual entity or relationship.
      • +
    • {record_delimiter} - A delimiter for separating tuple instances.
      • +
    • {completion_delimiter} - An indicator for when generation is complete.
      • +
    +

    Summarize Entity/Relationship Descriptions

    +

    Prompt Source

    +

    Tokens (values provided by extractor)

    +
      +
    • {entity_name} - The name of the entity or the source/target pair of the relationship.
      • +
    • {description_list} - A list of descriptions for the entity or relationship.
      • +
    +

    Claim Extraction

    +

    Prompt Source

    +

    Tokens (values provided by extractor)

    +
      +
    • {input_text} - The input text to be processed.
      • +
    • {tuple_delimiter} - A delimiter for separating values within a tuple. A single tuple is used to represent an individual entity or relationship.
      • +
    • {record_delimiter} - A delimiter for separating tuple instances.
      • +
    • {completion_delimiter} - An indicator for when generation is complete.
      • +
    +

    Note: there is additional paramater for the Claim Description that is used in claim extraction. +The default value is

    +

    "Any claims or facts that could be relevant to information discovery."

    +

    See the configuration documentation for details on how to change this.

    +

    Generate Community Reports

    +

    Prompt Source

    +

    Tokens (values provided by extractor)

    +
      +
    • {input_text} - The input text to generate the report with. This will contain tables of entities and relationships.
      • +
    + +
    +
    + + + \ No newline at end of file diff --git a/posts/index/overview/index.html b/posts/index/overview/index.html index ff1d71ba..d7c40231 100644 --- a/posts/index/overview/index.html +++ b/posts/index/overview/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/aggregate/index.html b/posts/index/verbs/aggregate/index.html index 223d7ec3..2805cf7c 100644 --- a/posts/index/verbs/aggregate/index.html +++ b/posts/index/verbs/aggregate/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/chunk/index.html b/posts/index/verbs/chunk/index.html index dc8db164..ffba5a0f 100644 --- a/posts/index/verbs/chunk/index.html +++ b/posts/index/verbs/chunk/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/cluster_graph/index.html b/posts/index/verbs/cluster_graph/index.html index 2c9d5deb..80011a58 100644 --- a/posts/index/verbs/cluster_graph/index.html +++ b/posts/index/verbs/cluster_graph/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/concat/index.html b/posts/index/verbs/concat/index.html index 13c5af76..9772fc29 100644 --- a/posts/index/verbs/concat/index.html +++ b/posts/index/verbs/concat/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/create_graph/index.html b/posts/index/verbs/create_graph/index.html index a8c542b6..0952105c 100644 --- a/posts/index/verbs/create_graph/index.html +++ b/posts/index/verbs/create_graph/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/genid/index.html b/posts/index/verbs/genid/index.html index 5e621239..c4bcd87c 100644 --- a/posts/index/verbs/genid/index.html +++ b/posts/index/verbs/genid/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/layout_graph/index.html b/posts/index/verbs/layout_graph/index.html index 0aa6f7cb..a4c0659f 100644 --- a/posts/index/verbs/layout_graph/index.html +++ b/posts/index/verbs/layout_graph/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/merge/index.html b/posts/index/verbs/merge/index.html index 696f0d9d..9cf13b95 100644 --- a/posts/index/verbs/merge/index.html +++ b/posts/index/verbs/merge/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/merge_graphs/index.html b/posts/index/verbs/merge_graphs/index.html index be54b552..a93c07e3 100644 --- a/posts/index/verbs/merge_graphs/index.html +++ b/posts/index/verbs/merge_graphs/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/overview/index.html b/posts/index/verbs/overview/index.html index ed3c7c8b..8bef9cb5 100644 --- a/posts/index/verbs/overview/index.html +++ b/posts/index/verbs/overview/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/spread_json/index.html b/posts/index/verbs/spread_json/index.html index 518d3149..6c2b70e1 100644 --- a/posts/index/verbs/spread_json/index.html +++ b/posts/index/verbs/spread_json/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/text_replace/index.html b/posts/index/verbs/text_replace/index.html index faddabae..59c7d304 100644 --- a/posts/index/verbs/text_replace/index.html +++ b/posts/index/verbs/text_replace/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/text_split/index.html b/posts/index/verbs/text_split/index.html index 402430a5..1b4d630c 100644 --- a/posts/index/verbs/text_split/index.html +++ b/posts/index/verbs/text_split/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/unpack_graph/index.html b/posts/index/verbs/unpack_graph/index.html index 87da3789..ec819700 100644 --- a/posts/index/verbs/unpack_graph/index.html +++ b/posts/index/verbs/unpack_graph/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/unzip/index.html b/posts/index/verbs/unzip/index.html index eb368930..bae91d5c 100644 --- a/posts/index/verbs/unzip/index.html +++ b/posts/index/verbs/unzip/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/verbs/zip/index.html b/posts/index/verbs/zip/index.html index f56286df..85e08005 100644 --- a/posts/index/verbs/zip/index.html +++ b/posts/index/verbs/zip/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_base_documents/index.html b/posts/index/workflows/create_base_documents/index.html index cdd0a274..3fb0c02c 100644 --- a/posts/index/workflows/create_base_documents/index.html +++ b/posts/index/workflows/create_base_documents/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_base_entity_graph/index.html b/posts/index/workflows/create_base_entity_graph/index.html index 8050d77e..e94927b8 100644 --- a/posts/index/workflows/create_base_entity_graph/index.html +++ b/posts/index/workflows/create_base_entity_graph/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_base_extracted_entities/index.html b/posts/index/workflows/create_base_extracted_entities/index.html index bd70f646..2e719f73 100644 --- a/posts/index/workflows/create_base_extracted_entities/index.html +++ b/posts/index/workflows/create_base_extracted_entities/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_base_text_units/index.html b/posts/index/workflows/create_base_text_units/index.html index d2261a46..184bbaee 100644 --- a/posts/index/workflows/create_base_text_units/index.html +++ b/posts/index/workflows/create_base_text_units/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_communities/index.html b/posts/index/workflows/create_final_communities/index.html index c5c4b04d..96b588b1 100644 --- a/posts/index/workflows/create_final_communities/index.html +++ b/posts/index/workflows/create_final_communities/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_community_reports/index.html b/posts/index/workflows/create_final_community_reports/index.html index 487b7eb0..d49885ae 100644 --- a/posts/index/workflows/create_final_community_reports/index.html +++ b/posts/index/workflows/create_final_community_reports/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_covariates/index.html b/posts/index/workflows/create_final_covariates/index.html index 7c1997b9..fe11cb5b 100644 --- a/posts/index/workflows/create_final_covariates/index.html +++ b/posts/index/workflows/create_final_covariates/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_documents/index.html b/posts/index/workflows/create_final_documents/index.html index c5a98ada..71844da5 100644 --- a/posts/index/workflows/create_final_documents/index.html +++ b/posts/index/workflows/create_final_documents/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_entities/index.html b/posts/index/workflows/create_final_entities/index.html index 88b48666..2acfa5bb 100644 --- a/posts/index/workflows/create_final_entities/index.html +++ b/posts/index/workflows/create_final_entities/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_nodes/index.html b/posts/index/workflows/create_final_nodes/index.html index 551647b5..60b18173 100644 --- a/posts/index/workflows/create_final_nodes/index.html +++ b/posts/index/workflows/create_final_nodes/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_relationships/index.html b/posts/index/workflows/create_final_relationships/index.html index fdd173fd..522e5807 100644 --- a/posts/index/workflows/create_final_relationships/index.html +++ b/posts/index/workflows/create_final_relationships/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_final_text_units/index.html b/posts/index/workflows/create_final_text_units/index.html index 67d053e8..7888a493 100644 --- a/posts/index/workflows/create_final_text_units/index.html +++ b/posts/index/workflows/create_final_text_units/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/create_summarized_entities/index.html b/posts/index/workflows/create_summarized_entities/index.html index 4b26f361..9820ed55 100644 --- a/posts/index/workflows/create_summarized_entities/index.html +++ b/posts/index/workflows/create_summarized_entities/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/index/workflows/overview/index.html b/posts/index/workflows/overview/index.html index ecf8ac66..f342a881 100644 --- a/posts/index/workflows/overview/index.html +++ b/posts/index/workflows/overview/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/0-global_search/index.html b/posts/query/0-global_search/index.html index 8ca8bbe5..8ffa3e64 100644 --- a/posts/query/0-global_search/index.html +++ b/posts/query/0-global_search/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/1-local_search/index.html b/posts/query/1-local_search/index.html index 7e562be3..4fe424cf 100644 --- a/posts/query/1-local_search/index.html +++ b/posts/query/1-local_search/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/2-question_generation/index.html b/posts/query/2-question_generation/index.html index ff9cc041..559e6f3f 100644 --- a/posts/query/2-question_generation/index.html +++ b/posts/query/2-question_generation/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/3-cli/index.html b/posts/query/3-cli/index.html index fae5bb05..c336bba4 100644 --- a/posts/query/3-cli/index.html +++ b/posts/query/3-cli/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/notebooks/global_search_nb/index.html b/posts/query/notebooks/global_search_nb/index.html index 0d913447..2c238b46 100644 --- a/posts/query/notebooks/global_search_nb/index.html +++ b/posts/query/notebooks/global_search_nb/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/notebooks/local_search_nb/index.html b/posts/query/notebooks/local_search_nb/index.html index 97e8e72d..47aed198 100644 --- a/posts/query/notebooks/local_search_nb/index.html +++ b/posts/query/notebooks/local_search_nb/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/notebooks/overview/index.html b/posts/query/notebooks/overview/index.html index 6d2e0e04..6b7072a2 100644 --- a/posts/query/notebooks/overview/index.html +++ b/posts/query/notebooks/overview/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows diff --git a/posts/query/overview/index.html b/posts/query/overview/index.html index c8b0c2c6..73539117 100644 --- a/posts/query/overview/index.html +++ b/posts/query/overview/index.html @@ -200,6 +200,8 @@ a {
  • CLI
  • +Prompt Tuning +
  • Workflows