kanshan/graphrag
1
0
Fork 0
mirror of https://github.com/microsoft/graphrag.git synced 2026-01-28 23:02:02 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity
f7ca10eba0
graphrag/index/outputs/index.html

2102 lines
46 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../default_dataflow/">
<link rel="next" href="../../prompt_tuning/overview/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
<title>Outputs - GraphRAG</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.6f8fc17f.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<script src="https://wcpstatic.microsoft.com/mscc/lib/v2/wcp-consent.js"></script>
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../stylesheets/extra.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#outputs" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="GraphRAG" class="md-header__button md-logo" aria-label="GraphRAG" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19.375 8.5a3.25 3.25 0 1 1-3.163 4h-3a3.252 3.252 0 0 1-4.443 2.509L7.214 17.76a3.25 3.25 0 1 1-1.342-.674l1.672-2.957A3.24 3.24 0 0 1 6.75 12c0-.907.371-1.727.97-2.316L6.117 6.846A3.253 3.253 0 0 1 1.875 3.75a3.25 3.25 0 1 1 5.526 2.32l1.603 2.836A3.25 3.25 0 0 1 13.093 11h3.119a3.25 3.25 0 0 1 3.163-2.5M10 10.25a1.75 1.75 0 1 0-.001 3.499A1.75 1.75 0 0 0 10 10.25M5.125 2a1.75 1.75 0 1 0 0 3.5 1.75 1.75 0 0 0 0-3.5m12.5 9.75a1.75 1.75 0 1 0 3.5 0 1.75 1.75 0 0 0-3.5 0m-14.25 8.5a1.75 1.75 0 1 0 3.501-.001 1.75 1.75 0 0 0-3.501.001"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
GraphRAG
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Outputs
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/microsoft/graphrag" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
</div>
<div class="md-source__repository">
graphrag
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../overview/" class="md-tabs__link">
Indexing
</a>
</li>
<li class="md-tabs__item">
<a href="../../prompt_tuning/overview/" class="md-tabs__link">
Prompt Tuning
</a>
</li>
<li class="md-tabs__item">
<a href="../../query/overview/" class="md-tabs__link">
Query
</a>
</li>
<li class="md-tabs__item">
<a href="../../config/overview/" class="md-tabs__link">
Configuration
</a>
</li>
<li class="md-tabs__item">
<a href="../../cli/" class="md-tabs__link">
CLI
</a>
</li>
<li class="md-tabs__item">
<a href="../../blog_posts/" class="md-tabs__link">
Extras
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="GraphRAG" class="md-nav__button md-logo" aria-label="GraphRAG" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19.375 8.5a3.25 3.25 0 1 1-3.163 4h-3a3.252 3.252 0 0 1-4.443 2.509L7.214 17.76a3.25 3.25 0 1 1-1.342-.674l1.672-2.957A3.24 3.24 0 0 1 6.75 12c0-.907.371-1.727.97-2.316L6.117 6.846A3.253 3.253 0 0 1 1.875 3.75a3.25 3.25 0 1 1 5.526 2.32l1.603 2.836A3.25 3.25 0 0 1 13.093 11h3.119a3.25 3.25 0 0 1 3.163-2.5M10 10.25a1.75 1.75 0 1 0-.001 3.499A1.75 1.75 0 0 0 10 10.25M5.125 2a1.75 1.75 0 1 0 0 3.5 1.75 1.75 0 0 0 0-3.5m12.5 9.75a1.75 1.75 0 1 0 3.5 0 1.75 1.75 0 0 0-3.5 0m-14.25 8.5a1.75 1.75 0 1 0 3.501-.001 1.75 1.75 0 0 0-3.501.001"/></svg>
</a>
GraphRAG
</label>
<div class="md-nav__source">
<a href="https://github.com/microsoft/graphrag" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
</div>
<div class="md-source__repository">
graphrag
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Welcome
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../get_started/" class="md-nav__link">
<span class="md-ellipsis">
Getting Started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../developing/" class="md-nav__link">
<span class="md-ellipsis">
Development Guide
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Indexing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Indexing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Outputs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Outputs
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#shared-fields" class="md-nav__link">
<span class="md-ellipsis">
Shared fields
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_communities" class="md-nav__link">
<span class="md-ellipsis">
create_final_communities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_community_reports" class="md-nav__link">
<span class="md-ellipsis">
create_final_community_reports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_covariates" class="md-nav__link">
<span class="md-ellipsis">
create_final_covariates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_documents" class="md-nav__link">
<span class="md-ellipsis">
create_final_documents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_entities" class="md-nav__link">
<span class="md-ellipsis">
create_final_entities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_nodes" class="md-nav__link">
<span class="md-ellipsis">
create_final_nodes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_relationships" class="md-nav__link">
<span class="md-ellipsis">
create_final_relationships
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_text_units" class="md-nav__link">
<span class="md-ellipsis">
create_final_text_units
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Prompt Tuning
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Prompt Tuning
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../prompt_tuning/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../prompt_tuning/auto_prompt_tuning/" class="md-nav__link">
<span class="md-ellipsis">
Auto Tuning
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../prompt_tuning/manual_prompt_tuning/" class="md-nav__link">
<span class="md-ellipsis">
Manual Tuning
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Query
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Query
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../query/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../query/global_search/" class="md-nav__link">
<span class="md-ellipsis">
Global Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../query/local_search/" class="md-nav__link">
<span class="md-ellipsis">
Local Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../query/drift_search/" class="md-nav__link">
<span class="md-ellipsis">
DRIFT Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../query/question_generation/" class="md-nav__link">
<span class="md-ellipsis">
Question Generation
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_6" >
<label class="md-nav__link" for="__nav_4_6" id="__nav_4_6_label" tabindex="0">
<span class="md-ellipsis">
Notebooks
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_6">
<span class="md-nav__icon md-icon"></span>
Notebooks
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../query/notebooks/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples_notebooks/global_search/" class="md-nav__link">
<span class="md-ellipsis">
Global Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples_notebooks/local_search/" class="md-nav__link">
<span class="md-ellipsis">
Local Search
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../examples_notebooks/drift_search/" class="md-nav__link">
<span class="md-ellipsis">
DRIFT Search
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Configuration
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Configuration
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../config/overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../config/init/" class="md-nav__link">
<span class="md-ellipsis">
Init Command
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../config/yaml/" class="md-nav__link">
<span class="md-ellipsis">
Using YAML
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../cli/" class="md-nav__link">
<span class="md-ellipsis">
CLI
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Extras
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Extras
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../blog_posts/" class="md-nav__link">
<span class="md-ellipsis">
Microsoft Research Blog
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../visualization_guide/" class="md-nav__link">
<span class="md-ellipsis">
Visualization Guide
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7_3" >
<label class="md-nav__link" for="__nav_7_3" id="__nav_7_3_label" tabindex="0">
<span class="md-ellipsis">
Operation Dulce
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_7_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7_3">
<span class="md-nav__icon md-icon"></span>
Operation Dulce
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../data/operation_dulce/ABOUT/" class="md-nav__link">
<span class="md-ellipsis">
About
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../data/operation_dulce/Operation%20Dulce%20v2%201%201/" class="md-nav__link">
<span class="md-ellipsis">
Document
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#shared-fields" class="md-nav__link">
<span class="md-ellipsis">
Shared fields
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_communities" class="md-nav__link">
<span class="md-ellipsis">
create_final_communities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_community_reports" class="md-nav__link">
<span class="md-ellipsis">
create_final_community_reports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_covariates" class="md-nav__link">
<span class="md-ellipsis">
create_final_covariates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_documents" class="md-nav__link">
<span class="md-ellipsis">
create_final_documents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_entities" class="md-nav__link">
<span class="md-ellipsis">
create_final_entities
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_nodes" class="md-nav__link">
<span class="md-ellipsis">
create_final_nodes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_relationships" class="md-nav__link">
<span class="md-ellipsis">
create_final_relationships
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create_final_text_units" class="md-nav__link">
<span class="md-ellipsis">
create_final_text_units
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="outputs">Outputs</h1>
<p>The default pipeline produces a series of output tables that align with the <a href="../default_dataflow/">conceptual knowledge model</a>. This page describes the detailed output table schemas. By default we write these tables out as parquet files on disk.</p>
<h2 id="shared-fields">Shared fields</h2>
<p>All tables have two identifier fields:</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>str</td>
<td>Generated UUID, assuring global uniqueness</td>
</tr>
<tr>
<td>human_readable_id</td>
<td>int</td>
<td>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.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_communities">create_final_communities</h2>
<p>This is a list of the final communities generated by Leiden. Communities are strictly hierarchical, subdividing into children as the cluster affinity is narrowed.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>community</td>
<td>int</td>
<td>Leiden-generated cluster ID for the community. Note that these increment with depth, so they are unique through all levels of the community hierarchy. For this table, human_readable_id is a copy of the community ID rather than a plain increment.</td>
</tr>
<tr>
<td>parent</td>
<td>int</td>
<td>Parent community ID.</td>
</tr>
<tr>
<td>level</td>
<td>int</td>
<td>Depth of the community in the hierarchy.</td>
</tr>
<tr>
<td>title</td>
<td>str</td>
<td>Friendly name of the community.</td>
</tr>
<tr>
<td>entity_ids</td>
<td>str[]</td>
<td>List of entities that are members of the community.</td>
</tr>
<tr>
<td>relationship_ids</td>
<td>str[]</td>
<td>List of relationships that are wholly within the community (source and target are both in the community).</td>
</tr>
<tr>
<td>text_unit_ids</td>
<td>str[]</td>
<td>List of text units represented within the community.</td>
</tr>
<tr>
<td>period</td>
<td>str</td>
<td>Date of ingest, used for incremental update merges. ISO8601</td>
</tr>
<tr>
<td>size</td>
<td>int</td>
<td>Size of the community (entity count), used for incremental update merges.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_community_reports">create_final_community_reports</h2>
<p>This is the list of summarized reports for each community.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>community</td>
<td>int</td>
<td>Short ID of the community this report applies to.</td>
</tr>
<tr>
<td>parent</td>
<td>int</td>
<td>Parent community ID.</td>
</tr>
<tr>
<td>level</td>
<td>int</td>
<td>Level of the community this report applies to.</td>
</tr>
<tr>
<td>title</td>
<td>str</td>
<td>LM-generated title for the report.</td>
</tr>
<tr>
<td>summary</td>
<td>str</td>
<td>LM-generated summary of the report.</td>
</tr>
<tr>
<td>full_content</td>
<td>str</td>
<td>LM-generated full report.</td>
</tr>
<tr>
<td>rank</td>
<td>float</td>
<td>LM-derived relevance ranking of the report based on member entity salience</td>
</tr>
<tr>
<td>rank_explanation</td>
<td>str</td>
<td>LM-derived explanation of the rank.</td>
</tr>
<tr>
<td>findings</td>
<td>dict</td>
<td>LM-derived list of the top 5-10 insights from the community. Contains <code>summary</code> and <code>explanation</code> values.</td>
</tr>
<tr>
<td>full_content_json</td>
<td>json</td>
<td>Full JSON output as returned by the LM. Most fields are extracted into columns, but this JSON is sent for query summarization so we leave it to allow for prompt tuning to add fields/content by end users.</td>
</tr>
<tr>
<td>period</td>
<td>str</td>
<td>Date of ingest, used for incremental update merges. ISO8601</td>
</tr>
<tr>
<td>size</td>
<td>int</td>
<td>Size of the community (entity count), used for incremental update merges.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_covariates">create_final_covariates</h2>
<p>(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.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>covariate_type</td>
<td>str</td>
<td>This is always "claim" with our default covariates.</td>
</tr>
<tr>
<td>type</td>
<td>str</td>
<td>Nature of the claim type.</td>
</tr>
<tr>
<td>description</td>
<td>str</td>
<td>LM-generated description of the behavior.</td>
</tr>
<tr>
<td>subject_id</td>
<td>str</td>
<td>Name of the source entity (that is performing the claimed behavior).</td>
</tr>
<tr>
<td>object_id</td>
<td>str</td>
<td>Name of the target entity (that the claimed behavior is performed on).</td>
</tr>
<tr>
<td>status</td>
<td>str</td>
<td>LM-derived assessment of the correctness of the claim. One of [TRUE, FALSE, SUSPECTED]</td>
</tr>
<tr>
<td>start_date</td>
<td>str</td>
<td>LM-derived start of the claimed activity. ISO8601</td>
</tr>
<tr>
<td>end_date</td>
<td>str</td>
<td>LM-derived end of the claimed activity. ISO8601</td>
</tr>
<tr>
<td>source_text</td>
<td>str</td>
<td>Short string of text containing the claimed behavior.</td>
</tr>
<tr>
<td>text_unit_id</td>
<td>str</td>
<td>ID of the text unit the claim text was extracted from.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_documents">create_final_documents</h2>
<p>List of document content after import.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>title</td>
<td>str</td>
<td>Filename, unless otherwise configured during CSV import.</td>
</tr>
<tr>
<td>text</td>
<td>str</td>
<td>Full text of the document.</td>
</tr>
<tr>
<td>text_unit_ids</td>
<td>str[]</td>
<td>List of text units (chunks) that were parsed from the document.</td>
</tr>
<tr>
<td>attributes</td>
<td>dict</td>
<td>(optional) If specified during CSV import, this is a dict of attributes for the document.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_entities">create_final_entities</h2>
<p>List of all entities found in the data by the LM.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>title</td>
<td>str</td>
<td>Name of the entity.</td>
</tr>
<tr>
<td>type</td>
<td>str</td>
<td>Type of the entity. By default this will be "organization", "person", "geo", or "event" unless configured differently or auto-tuning is used.</td>
</tr>
<tr>
<td>description</td>
<td>str</td>
<td>Textual description of the entity. Entities may be found in many text units, so this is an LM-derived summary of all descriptions.</td>
</tr>
<tr>
<td>text_unit_ids</td>
<td>str[]</td>
<td>List of the text units containing the entity.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_nodes">create_final_nodes</h2>
<p>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.</p>
<p>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.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>title</td>
<td>str</td>
<td>Name of the referenced entity. Duplicated from create_final_entities for convenient cross-referencing.</td>
</tr>
<tr>
<td>community</td>
<td>int</td>
<td>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.</td>
</tr>
<tr>
<td>level</td>
<td>int</td>
<td>Level of the community the entity is in.</td>
</tr>
<tr>
<td>degree</td>
<td>int</td>
<td>Node degree (connectedness) in the graph.</td>
</tr>
<tr>
<td>x</td>
<td>float</td>
<td>X position of the node for visual layouts. If graph embeddings and UMAP are not turned on, this will be 0.</td>
</tr>
<tr>
<td>y</td>
<td>float</td>
<td>Y position of the node for visual layouts. If graph embeddings and UMAP are not turned on, this will be 0.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_relationships">create_final_relationships</h2>
<p>List of all entity-to-entity relationships found in the data by the LM. This is also the <em>edge list</em> for the graph.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>source</td>
<td>str</td>
<td>Name of the source entity.</td>
</tr>
<tr>
<td>target</td>
<td>str</td>
<td>Name of the target entity.</td>
</tr>
<tr>
<td>description</td>
<td>str</td>
<td>LM-derived description of the relationship. Also see note for entity descriptions.</td>
</tr>
<tr>
<td>weight</td>
<td>float</td>
<td>Weight of the edge in the graph. This is summed from an LM-derived "strength" measure for each relationship instance.</td>
</tr>
<tr>
<td>combined_degree</td>
<td>int</td>
<td>Sum of source and target node degrees.</td>
</tr>
<tr>
<td>text_unit_ids</td>
<td>str[]</td>
<td>List of text units the relationship was found within.</td>
</tr>
</tbody>
</table>
<h2 id="create_final_text_units">create_final_text_units</h2>
<p>List of all text chunks parsed from the input documents.</p>
<table>
<thead>
<tr>
<th>name</th>
<th>type</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>str</td>
<td>Raw full text of the chunk.</td>
</tr>
<tr>
<td>n_tokens</td>
<td>int</td>
<td>Number of tokens in the chunk. This should normally match the <code>chunk_size</code> config parameter, except for the last chunk which is often shorter.</td>
</tr>
<tr>
<td>document_ids</td>
<td>str[]</td>
<td>List of document IDs the chunk came from. This is normally only 1 due to our default groupby, but for very short text documents (e.g., microblogs) it can be configured so text units span multiple documents.</td>
</tr>
<tr>
<td>entity_ids</td>
<td>str[]</td>
<td>List of entities found in the text unit.</td>
</tr>
<tr>
<td>relationships_ids</td>
<td>str[]</td>
<td>List of relationships found in the text unit.</td>
</tr>
<tr>
<td>covariate_ids</td>
<td>str[]</td>
<td>Optional list of covariates found in the text unit.</td>
</tr>
</tbody>
</table>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../default_dataflow/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Dataflow">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Dataflow
</div>
</div>
</a>
<a href="../../prompt_tuning/overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Overview
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
&copy; 2025 Microsoft&nbsp;|&nbsp; <a href="https://go.microsoft.com/fwlink/?LinkId=521839">Privacy</a>&nbsp;|&nbsp; <a href="https://go.microsoft.com/fwlink/?LinkId=2259814">Consumer Heath Privacy</a>&nbsp;|&nbsp; <a onclick="window.manageConsent();">Cookies</a>&nbsp;|&nbsp; <a href="https://go.microsoft.com/fwlink/?LinkID=206977">Terms of Use</a>&nbsp;|&nbsp; <a href="https://www.microsoft.com/trademarks">Trademarks</a>
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "navigation.footer", "navigation.tabs"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
<script src="../../scripts/create_cookie_banner.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink