2024-10-11 19:40:33 +00:00
<!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 = "../get_started/" >
< link rel = "next" href = "../index/overview/" >
< link rel = "icon" href = "../assets/images/favicon.png" >
2024-11-05 17:47:33 +00:00
< meta name = "generator" content = "mkdocs-1.6.1, mkdocs-material-9.5.43" >
2024-10-11 19:40:33 +00:00
< title > Development Guide - GraphRAG< / title >
2024-10-30 21:51:16 +00:00
< link rel = "stylesheet" href = "../assets/stylesheets/main.0253249f.min.css" >
2024-10-11 19:40:33 +00:00
< 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 = "#development-guide" 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" >
Development Guide
< / 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.6.0 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 md-tabs__item--active" >
< a href = ".." class = "md-tabs__link" >
Home
< / a >
< / li >
< li class = "md-tabs__item" >
< a href = "../index/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 = "../blog_posts/" class = "md-tabs__link" >
Microsoft Research Blog
< / a >
< / li >
< li class = "md-tabs__item" >
2024-10-25 23:02:17 +00:00
< a href = "../cli/" class = "md-tabs__link" >
2024-10-11 19:40:33 +00:00
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.6.0 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--active md-nav__item--section md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_1" checked >
< label class = "md-nav__link" for = "__nav_1" id = "__nav_1_label" tabindex = "" >
< 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 = "true" >
< 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 md-nav__item--active" >
< input class = "md-nav__toggle md-toggle" type = "checkbox" id = "__toc" >
< a href = "./" class = "md-nav__link md-nav__link--active" >
< span class = "md-ellipsis" >
Development Guide
< / 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_2" >
< label class = "md-nav__link" for = "__nav_2" id = "__nav_2_label" tabindex = "0" >
< 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 = "false" >
< 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 = "../index/overview/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Overview
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../index/architecture/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Architecture
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../index/default_dataflow/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Dataflow
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2024-10-25 23:02:17 +00:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_2_4" >
2024-10-11 19:40:33 +00:00
2024-10-25 23:02:17 +00:00
< label class = "md-nav__link" for = "__nav_2_4" id = "__nav_2_4_label" tabindex = "0" >
2024-10-11 19:40:33 +00:00
< span class = "md-ellipsis" >
Configuration
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2024-10-25 23:02:17 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_2_4_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_2_4" >
2024-10-11 19:40:33 +00:00
< 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/env_vars/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Using Env Vars
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/json_yaml/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Using JSON or YAML
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/custom/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Fully Custom
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../config/template/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Template
< / 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/local_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Local 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" >
< a href = "../query/global_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Global Search
< / span >
< / a >
< / li >
< li class = "md-nav__item md-nav__item--nested" >
2024-10-25 23:02:17 +00:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_4_5" >
2024-10-11 19:40:33 +00:00
2024-10-25 23:02:17 +00:00
< label class = "md-nav__link" for = "__nav_4_5" id = "__nav_4_5_label" tabindex = "0" >
2024-10-11 19:40:33 +00:00
< span class = "md-ellipsis" >
Notebooks
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2024-10-25 23:02:17 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_4_5_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_4_5" >
2024-10-11 19:40:33 +00:00
< 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 >
< / ul >
< / nav >
< / li >
< / ul >
< / nav >
< / li >
< 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 md-nav__item--nested" >
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_6" >
< label class = "md-nav__link" for = "__nav_6" id = "__nav_6_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_6_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_6" >
< span class = "md-nav__icon md-icon" > < / span >
Extras
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
2024-10-25 23:02:17 +00:00
< li class = "md-nav__item" >
< a href = "../cli/" class = "md-nav__link" >
< span class = "md-ellipsis" >
CLI
< / span >
< / a >
< / li >
2024-10-11 19:40:33 +00:00
< li class = "md-nav__item md-nav__item--nested" >
2024-10-25 23:02:17 +00:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_6_2" >
2024-10-11 19:40:33 +00:00
2024-10-25 23:02:17 +00:00
< label class = "md-nav__link" for = "__nav_6_2" id = "__nav_6_2_label" tabindex = "0" >
2024-10-11 19:40:33 +00:00
< span class = "md-ellipsis" >
Operation Dulce
< / span >
< span class = "md-nav__icon md-icon" > < / span >
< / label >
2024-10-25 23:02:17 +00:00
< nav class = "md-nav" data-md-level = "2" aria-labelledby = "__nav_6_2_label" aria-expanded = "false" >
< label class = "md-nav__title" for = "__nav_6_2" >
2024-10-11 19:40:33 +00:00
< 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" >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 id = "development-guide" > Development Guide< / h1 >
< h1 id = "requirements" > Requirements< / h1 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Installation< / th >
< th > Purpose< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > Python 3.10-3.12< / td >
< td > < a href = "https://www.python.org/downloads/" > Download< / a > < / td >
< td > The library is Python-based.< / td >
< / tr >
< tr >
< td > Poetry< / td >
< td > < a href = "https://python-poetry.org/docs/#installation" > Instructions< / a > < / td >
< td > Poetry is used for package management and virtualenv management in Python codebases< / td >
< / tr >
< / tbody >
< / table >
< h1 id = "getting-started" > Getting Started< / h1 >
< h2 id = "install-dependencies" > Install Dependencies< / h2 >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-0-1" name = "__codelineno-0-1" href = "#__codelineno-0-1" > < / a > < span class = "c1" > # Install Python dependencies.< / span >
< a id = "__codelineno-0-2" name = "__codelineno-0-2" href = "#__codelineno-0-2" > < / a > poetry< span class = "w" > < / span > install
< / code > < / pre > < / div >
< h2 id = "execute-the-indexing-engine" > Execute the Indexing Engine< / h2 >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-1-1" name = "__codelineno-1-1" href = "#__codelineno-1-1" > < / a > poetry< span class = "w" > < / span > run< span class = "w" > < / span > poe< span class = "w" > < / span > index< span class = "w" > < / span > < ...args>
< / code > < / pre > < / div >
< h2 id = "executing-queries" > Executing Queries< / h2 >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-2-1" name = "__codelineno-2-1" href = "#__codelineno-2-1" > < / a > poetry< span class = "w" > < / span > run< span class = "w" > < / span > poe< span class = "w" > < / span > query< span class = "w" > < / span > < ...args>
< / code > < / pre > < / div >
< h1 id = "azurite" > Azurite< / h1 >
< p > Some unit and smoke tests use Azurite to emulate Azure resources. This can be started by running:< / p >
< div class = "highlight" > < pre > < span > < / span > < code > < a id = "__codelineno-3-1" name = "__codelineno-3-1" href = "#__codelineno-3-1" > < / a > ./scripts/start-azurite.sh
< / code > < / pre > < / div >
< p > or by simply running < code > azurite< / code > in the terminal if already installed globally. See the < a href = "https://learn.microsoft.com/en-us/azure/storage/common/storage-use-azurite" > Azurite documentation< / a > for more information about how to install and use Azurite.< / p >
< h1 id = "lifecycle-scripts" > Lifecycle Scripts< / h1 >
< p > Our Python package utilizes Poetry to manage dependencies and < a href = "https://pypi.org/project/poethepoet/" > poethepoet< / a > to manage build scripts.< / p >
< p > Available scripts are:< / p >
< ul >
< li > < code > poetry run poe index< / code > - Run the Indexing CLI< / li >
< li > < code > poetry run poe query< / code > - Run the Query CLI< / li >
< li > < code > poetry build< / code > - This invokes < code > poetry build< / code > , which will build a wheel file and other distributable artifacts.< / li >
< li > < code > poetry run poe test< / code > - This will execute all tests.< / li >
< li > < code > poetry run poe test_unit< / code > - This will execute unit tests.< / li >
< li > < code > poetry run poe test_integration< / code > - This will execute integration tests.< / li >
< li > < code > poetry run poe test_smoke< / code > - This will execute smoke tests.< / li >
< li > < code > poetry run poe check< / code > - This will perform a suite of static checks across the package, including:< / li >
< li > formatting< / li >
< li > documentation formatting< / li >
< li > linting< / li >
< li > security patterns< / li >
< li > type-checking< / li >
< li > < code > poetry run poe fix< / code > - This will apply any available auto-fixes to the package. Usually this is just formatting fixes.< / li >
< li > < code > poetry run poe fix_unsafe< / code > - This will apply any available auto-fixes to the package, including those that may be unsafe.< / li >
< li > < code > poetry run poe format< / code > - Explicitly run the formatter across the package.< / li >
< / ul >
< h2 id = "troubleshooting" > Troubleshooting< / h2 >
< h3 id = "runtimeerror-llvm-config-failed-executing-please-point-llvm_config-to-the-path-for-llvm-config-when-running-poetry-install" > "RuntimeError: llvm-config failed executing, please point LLVM_CONFIG to the path for llvm-config" when running poetry install< / h3 >
< p > Make sure llvm-9 and llvm-9-dev are installed:< / p >
< p > < code > sudo apt-get install llvm-9 llvm-9-dev< / code > < / p >
< p > and then in your bashrc, add< / p >
< p > < code > export LLVM_CONFIG=/usr/bin/llvm-config-9< / code > < / p >
< h3 id = "numba_pymoduleh610-fatal-error-pythonh-no-such-file-or-directory-when-running-poetry-install" > "numba/_pymodule.h:6:10: fatal error: Python.h: No such file or directory" when running poetry install< / h3 >
< p > Make sure you have python3.10-dev installed or more generally < code > python< version> -dev< / code > < / p >
< p > < code > sudo apt-get install python3.10-dev< / code > < / p >
< h3 id = "llm-call-constantly-exceeds-tpm-rpm-or-time-limits" > LLM call constantly exceeds TPM, RPM or time limits< / h3 >
< p > < code > GRAPHRAG_LLM_THREAD_COUNT< / code > and < code > GRAPHRAG_EMBEDDING_THREAD_COUNT< / code > are both set to 50 by default. You can modify this values
to reduce concurrency. Please refer to the < a href = "../config/overview/" > Configuration Documents< / a > < / p >
< / 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 = "../get_started/" class = "md-footer__link md-footer__link--prev" aria-label = "Previous: Getting Started" >
< 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" >
Getting Started
< / div >
< / div >
< / a >
< a href = "../index/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" >
© 2025 Microsoft | < a href = "https://go.microsoft.com/fwlink/?LinkId=521839" > Privacy< / a > | < a href = "https://go.microsoft.com/fwlink/?LinkId=2259814" > Consumer Heath Privacy< / a > | < a onclick = "window.manageConsent();" > Cookies< / a > | < a href = "https://go.microsoft.com/fwlink/?LinkID=206977" > Terms of Use< / a > | < 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 >
2024-10-30 21:51:16 +00:00
< script src = "../assets/javascripts/bundle.83f73b43.min.js" > < / script >
2024-10-11 19:40:33 +00:00
< script src = "../scripts/create_cookie_banner.js" > < / script >
< / body >
< / html >
