2024-12-06 01:52:52 +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 = "icon" href = "../../assets/images/favicon.png" >
2025-03-22 05:17:21 +00:00
< meta name = "generator" content = "mkdocs-1.6.1, mkdocs-material-9.6.9" >
2024-12-06 01:52:52 +00:00
< title > Api overview - GraphRAG< / title >
2025-03-22 05:17:21 +00:00
< link rel = "stylesheet" href = "../../assets/stylesheets/main.4af4bdda.min.css" >
2024-12-06 01:52:52 +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 = "#api-overview" 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" >
Api overview
< / 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" >
2025-02-13 21:58:24 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.7.2 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 >
2024-12-06 01:52:52 +00:00
< / 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" >
< 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 = "../../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" >
2025-02-13 21:58:24 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.7.2 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 >
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../get_started/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Getting Started
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../developing/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Development Guide
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../index/architecture/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Architecture
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../index/default_dataflow/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Dataflow
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
2025-03-12 00:39:44 +00:00
< li class = "md-nav__item" >
< a href = "../../index/inputs/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Inputs
< / span >
< / a >
< / li >
2024-12-06 01:52:52 +00:00
< li class = "md-nav__item" >
< a href = "../../index/outputs/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Outputs
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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_3" >
< label class = "md-nav__link" for = "__nav_3" id = "__nav_3_label" tabindex = "0" >
< span class = "md-ellipsis" >
Prompt Tuning
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../query/global_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Global Search
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../query/local_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Local Search
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../query/drift_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
DRIFT Search
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../query/question_generation/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Question Generation
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../global_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Global Search
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../local_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Local Search
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../drift_search/" class = "md-nav__link" >
< span class = "md-ellipsis" >
DRIFT Search
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../config/init/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Init Command
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../config/yaml/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Using YAML
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../config/env_vars/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Using Env Vars
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "../../cli/" class = "md-nav__link" >
< span class = "md-ellipsis" >
CLI
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "../../visualization_guide/" class = "md-nav__link" >
< span class = "md-ellipsis" >
Visualization Guide
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< / 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 = "#api-overview" class = "md-nav__link" >
< span class = "md-ellipsis" >
API Overview
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#prerequisite" class = "md-nav__link" >
< span class = "md-ellipsis" >
Prerequisite
< / span >
< / a >
< nav class = "md-nav" aria-label = "Prerequisite" >
< ul class = "md-nav__list" >
< li class = "md-nav__item" >
< a href = "#generate-a-object" class = "md-nav__link" >
< span class = "md-ellipsis" >
Generate a object
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / li >
< li class = "md-nav__item" >
< a href = "#indexing-api" class = "md-nav__link" >
< span class = "md-ellipsis" >
Indexing API
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#build-an-index" class = "md-nav__link" >
< span class = "md-ellipsis" >
Build an index
< / span >
< / a >
< / li >
< li class = "md-nav__item" >
< a href = "#query-an-index" class = "md-nav__link" >
< span class = "md-ellipsis" >
Query an index
< / span >
< / a >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
2025-02-13 21:58:24 +00:00
2024-12-06 01:52:52 +00:00
< h1 > Api overview< / h1 >
< script >
(function (global, factory) {
typeof exports === 'object' & & typeof module !== 'undefined' ? module.exports = factory() :
typeof define === 'function' & & define.amd ? define(factory) :
(global = global || self, global.ClipboardCopyElement = factory());
}(this, function () { 'use strict';
function createNode(text) {
const node = document.createElement('pre');
node.style.width = '1px';
node.style.height = '1px';
node.style.position = 'fixed';
node.style.top = '5px';
node.textContent = text;
return node;
}
function copyNode(node) {
if ('clipboard' in navigator) {
// eslint-disable-next-line flowtype/no-flow-fix-me-comments
// $FlowFixMe Clipboard is not defined in Flow yet.
return navigator.clipboard.writeText(node.textContent);
}
const selection = getSelection();
if (selection == null) {
return Promise.reject(new Error());
}
selection.removeAllRanges();
const range = document.createRange();
range.selectNodeContents(node);
selection.addRange(range);
document.execCommand('copy');
selection.removeAllRanges();
return Promise.resolve();
}
function copyText(text) {
if ('clipboard' in navigator) {
// eslint-disable-next-line flowtype/no-flow-fix-me-comments
// $FlowFixMe Clipboard is not defined in Flow yet.
return navigator.clipboard.writeText(text);
}
const body = document.body;
if (!body) {
return Promise.reject(new Error());
}
const node = createNode(text);
body.appendChild(node);
copyNode(node);
body.removeChild(node);
return Promise.resolve();
}
function copy(button) {
const id = button.getAttribute('for');
const text = button.getAttribute('value');
function trigger() {
button.dispatchEvent(new CustomEvent('clipboard-copy', {
bubbles: true
}));
}
if (text) {
copyText(text).then(trigger);
} else if (id) {
const root = 'getRootNode' in Element.prototype ? button.getRootNode() : button.ownerDocument;
if (!(root instanceof Document || 'ShadowRoot' in window & & root instanceof ShadowRoot)) return;
const node = root.getElementById(id);
if (node) copyTarget(node).then(trigger);
}
}
function copyTarget(content) {
if (content instanceof HTMLInputElement || content instanceof HTMLTextAreaElement) {
return copyText(content.value);
} else if (content instanceof HTMLAnchorElement & & content.hasAttribute('href')) {
return copyText(content.href);
} else {
return copyNode(content);
}
}
function clicked(event) {
const button = event.currentTarget;
if (button instanceof HTMLElement) {
copy(button);
}
}
function keydown(event) {
if (event.key === ' ' || event.key === 'Enter') {
const button = event.currentTarget;
if (button instanceof HTMLElement) {
event.preventDefault();
copy(button);
}
}
}
function focused(event) {
event.currentTarget.addEventListener('keydown', keydown);
}
function blurred(event) {
event.currentTarget.removeEventListener('keydown', keydown);
}
class ClipboardCopyElement extends HTMLElement {
constructor() {
super();
this.addEventListener('click', clicked);
this.addEventListener('focus', focused);
this.addEventListener('blur', blurred);
}
connectedCallback() {
if (!this.hasAttribute('tabindex')) {
this.setAttribute('tabindex', '0');
}
if (!this.hasAttribute('role')) {
this.setAttribute('role', 'button');
}
}
get value() {
return this.getAttribute('value') || '';
}
set value(text) {
this.setAttribute('value', text);
}
}
if (!window.customElements.get('clipboard-copy')) {
window.ClipboardCopyElement = ClipboardCopyElement;
window.customElements.define('clipboard-copy', ClipboardCopyElement);
}
return ClipboardCopyElement;
}));
< / script >
< script >
document.addEventListener('clipboard-copy', function(event) {
const notice = event.target.querySelector('.notice')
notice.hidden = false
setTimeout(function() {
notice.hidden = true
}, 1000)
})
< / script >
< style type = "text/css" >
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight-ipynb .hll { background-color: var(--jp-cell-editor-active-background) }
.highlight-ipynb { background: var(--jp-cell-editor-background); color: var(--jp-mirror-editor-variable-color) }
.highlight-ipynb .c { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment */
.highlight-ipynb .err { color: var(--jp-mirror-editor-error-color) } /* Error */
.highlight-ipynb .k { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword */
.highlight-ipynb .o { color: var(--jp-mirror-editor-operator-color); font-weight: bold } /* Operator */
.highlight-ipynb .p { color: var(--jp-mirror-editor-punctuation-color) } /* Punctuation */
.highlight-ipynb .ch { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Hashbang */
.highlight-ipynb .cm { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Multiline */
.highlight-ipynb .cp { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Preproc */
.highlight-ipynb .cpf { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.PreprocFile */
.highlight-ipynb .c1 { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Single */
.highlight-ipynb .cs { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Special */
.highlight-ipynb .kc { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Constant */
.highlight-ipynb .kd { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Declaration */
.highlight-ipynb .kn { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Namespace */
.highlight-ipynb .kp { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Pseudo */
.highlight-ipynb .kr { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Reserved */
.highlight-ipynb .kt { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Type */
.highlight-ipynb .m { color: var(--jp-mirror-editor-number-color) } /* Literal.Number */
.highlight-ipynb .s { color: var(--jp-mirror-editor-string-color) } /* Literal.String */
.highlight-ipynb .ow { color: var(--jp-mirror-editor-operator-color); font-weight: bold } /* Operator.Word */
.highlight-ipynb .pm { color: var(--jp-mirror-editor-punctuation-color) } /* Punctuation.Marker */
.highlight-ipynb .w { color: var(--jp-mirror-editor-variable-color) } /* Text.Whitespace */
.highlight-ipynb .mb { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Bin */
.highlight-ipynb .mf { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Float */
.highlight-ipynb .mh { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Hex */
.highlight-ipynb .mi { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Integer */
.highlight-ipynb .mo { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Oct */
.highlight-ipynb .sa { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Affix */
.highlight-ipynb .sb { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Backtick */
.highlight-ipynb .sc { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Char */
.highlight-ipynb .dl { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Delimiter */
.highlight-ipynb .sd { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Doc */
.highlight-ipynb .s2 { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Double */
.highlight-ipynb .se { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Escape */
.highlight-ipynb .sh { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Heredoc */
.highlight-ipynb .si { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Interpol */
.highlight-ipynb .sx { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Other */
.highlight-ipynb .sr { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Regex */
.highlight-ipynb .s1 { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Single */
.highlight-ipynb .ss { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Symbol */
.highlight-ipynb .il { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Integer.Long */
< / style >
< style type = "text/css" >
@charset "UTF-8";.jupyter-wrapper{--md-red-50: #ffebee;--md-red-100: #ffcdd2;--md-red-200: #ef9a9a;--md-red-300: #e57373;--md-red-400: #ef5350;--md-red-500: #f44336;--md-red-600: #e53935;--md-red-700: #d32f2f;--md-red-800: #c62828;--md-red-900: #b71c1c;--md-red-A100: #ff8a80;--md-red-A200: #ff5252;--md-red-A400: #ff1744;--md-red-A700: #d50000;--md-pink-50: #fce4ec;--md-pink-100: #f8bbd0;--md-pink-200: #f48fb1;--md-pink-300: #f06292;--md-pink-400: #ec407a;--md-pink-500: #e91e63;--md-pink-600: #d81b60;--md-pink-700: #c2185b;--md-pink-800: #ad1457;--md-pink-900: #880e4f;--md-pink-A100: #ff80ab;--md-pink-A200: #ff4081;--md-pink-A400: #f50057;--md-pink-A700: #c51162;--md-purple-50: #f3e5f5;--md-purple-100: #e1bee7;--md-purple-200: #ce93d8;--md-purple-300: #ba68c8;--md-purple-400: #ab47bc;--md-purple-500: #9c27b0;--md-purple-600: #8e24aa;--md-purple-700: #7b1fa2;--md-purple-800: #6a1b9a;--md-purple-900: #4a148c;--md-purple-A100: #ea80fc;--md-purple-A200: #e040fb;--md-purple-A400: #d500f9;--md-purple-A700: #aa00ff;--md-deep-purple-50: #ede7f6;--md-deep-purple-100: #d1c4e9;--md-deep-purple-200: #b39ddb;--md-deep-purple-300: #9575cd;--md-deep-purple-400: #7e57c2;--md-deep-purple-500: #673ab7;--md-deep-purple-600: #5e35b1;--md-deep-purple-700: #512da8;--md-deep-purple-800: #4527a0;--md-deep-purple-900: #311b92;--md-deep-purple-A100: #b388ff;--md-deep-purple-A200: #7c4dff;--md-deep-purple-A400: #651fff;--md-deep-purple-A700: #6200ea;--md-indigo-50: #e8eaf6;--md-indigo-100: #c5cae9;--md-indigo-200: #9fa8da;--md-indigo-300: #7986cb;--md-indigo-400: #5c6bc0;--md-indigo-500: #3f51b5;--md-indigo-600: #3949ab;--md-indigo-700: #303f9f;--md-indigo-800: #283593;--md-indigo-900: #1a237e;--md-indigo-A100: #8c9eff;--md-indigo-A200: #536dfe;--md-indigo-A400: #3d5afe;--md-indigo-A700: #304ffe;--md-blue-50: #e3f2fd;--md-blue-100: #bbdefb;--md-blue-200: #90caf9;--md-blue-300: #64b5f6;--md-blue-400: #42a5f5;--md-blue-500: #2196f3;--md-blue-600: #1e88e5;--md-blue-700: #1976d2;--md-blue-800: #1565c0;--md-blue-900: #0d47a1;--md-blue-A100: #82b1ff;--md-blue-A200: #448aff;--md-blue-A400: #2979ff;--md-blue-A700: #2962ff;--md-light-blue-50: #e1f5fe;--md-light-blue-100: #b3e5fc;--md-light-blue-200: #81d4fa;--md-light-blue-300: #4fc3f7;--md-light-blue-400: #29b6f6;--md-light-blue-500: #03a9f4;--md-light-blue-600: #039be5;--md-light-blue-700: #0288d1;--md-light-blue-800: #0277bd;--md-light-blue-900: #01579b;--md-light-blue-A100: #80d8ff;--md-light-blue-A200: #40c4ff;--md-light-blue-A400: #00b0ff;--md-light-blue-A700: #0091ea;--md-cyan-50: #e0f7fa;--md-cyan-100: #b2ebf2;--md-cyan-200: #80deea;--md-cyan-300: #4dd0e1;--md-cyan-400: #26c6da;--md-cyan-500: #00bcd4;--md-cyan-600: #00acc1;--md-cyan-700: #0097a7;--md-cyan-800: #00838f;--md-cyan-900: #006064;--md-cyan-A100: #84ffff;--md-cyan-A200: #18ffff;--md-cyan-A400: #00e5ff;--md-cyan-A700: #00b8d4;--md-teal-50: #e0f2f1;--md-teal-100: #b2dfdb;--md-teal-200: #80cbc4;--md-teal-300: #4db6ac;--md-teal-400: #26a69a;--md-teal-500: #009688;--md-teal-600: #00897b;--md-teal-700: #00796b;--md-teal-800: #00695c;--md-teal-900: #004d40;--md-teal-A100: #a7ffeb;--md-teal-A200: #64ffda;--md-teal-A400: #1de9b6;--md-teal-A700: #00bfa5;--md-green-50: #e8f5e9;--md-green-100: #c8e6c9;--md-green-200: #a5d6a7;--md-green-300: #81c784;--md-green-400: #66bb6a;--md-green-500: #4caf50;--md-green-600: #43a047;--md-green-700: #388e3c;--md-green-800: #2e7d32;--md-green-900: #1b5e20;--md-green-A100: #b9f6ca;--md-green-A200: #69f0ae;--md-green-A400: #00e676;--md-green-A700: #00c853;--md-light-green-50: #f1f8e9;--md-light-green-100: #dcedc8;--md-light-green-200: #c5e1a5;--md-light-green-300: #aed581;--md-light-green-400: #9ccc65;--md-light-green-500: #8bc34a;--md-light-green-600: #7cb342;--md-light-green-700: #689f38;--md-light-green-800: #558b2f;--md-light-green-900: #33691e;--md-light-green-A100: #ccff90;--md-light-green-A200: #b2ff59;--md-light-green-A400: #76ff03;--md-light-green-A700: #64dd17;--md-lime-50: #f9fbe7;--md-lime-100: #f0f4c3;--md-lime-200: #e6ee9c;--md-lime-300: #dce775;--md-lime-400: #d4e157;--md-lime-500: #cddc39;--md-lime-600
< / style >
< style type = "text/css" >
.jupyter-wrapper{--jp-shadow-base-lightness: 0;--jp-shadow-umbra-color: rgba( var(--jp-shadow-base-lightness), var(--jp-shadow-base-lightness), var(--jp-shadow-base-lightness), .2 );--jp-shadow-penumbra-color: rgba( var(--jp-shadow-base-lightness), var(--jp-shadow-base-lightness), var(--jp-shadow-base-lightness), .14 );--jp-shadow-ambient-color: rgba( var(--jp-shadow-base-lightness), var(--jp-shadow-base-lightness), var(--jp-shadow-base-lightness), .12 );--jp-elevation-z0: none;--jp-elevation-z1: 0px 2px 1px -1px var(--jp-shadow-umbra-color), 0px 1px 1px 0px var(--jp-shadow-penumbra-color), 0px 1px 3px 0px var(--jp-shadow-ambient-color);--jp-elevation-z2: 0px 3px 1px -2px var(--jp-shadow-umbra-color), 0px 2px 2px 0px var(--jp-shadow-penumbra-color), 0px 1px 5px 0px var(--jp-shadow-ambient-color);--jp-elevation-z4: 0px 2px 4px -1px var(--jp-shadow-umbra-color), 0px 4px 5px 0px var(--jp-shadow-penumbra-color), 0px 1px 10px 0px var(--jp-shadow-ambient-color);--jp-elevation-z6: 0px 3px 5px -1px var(--jp-shadow-umbra-color), 0px 6px 10px 0px var(--jp-shadow-penumbra-color), 0px 1px 18px 0px var(--jp-shadow-ambient-color);--jp-elevation-z8: 0px 5px 5px -3px var(--jp-shadow-umbra-color), 0px 8px 10px 1px var(--jp-shadow-penumbra-color), 0px 3px 14px 2px var(--jp-shadow-ambient-color);--jp-elevation-z12: 0px 7px 8px -4px var(--jp-shadow-umbra-color), 0px 12px 17px 2px var(--jp-shadow-penumbra-color), 0px 5px 22px 4px var(--jp-shadow-ambient-color);--jp-elevation-z16: 0px 8px 10px -5px var(--jp-shadow-umbra-color), 0px 16px 24px 2px var(--jp-shadow-penumbra-color), 0px 6px 30px 5px var(--jp-shadow-ambient-color);--jp-elevation-z20: 0px 10px 13px -6px var(--jp-shadow-umbra-color), 0px 20px 31px 3px var(--jp-shadow-penumbra-color), 0px 8px 38px 7px var(--jp-shadow-ambient-color);--jp-elevation-z24: 0px 11px 15px -7px var(--jp-shadow-umbra-color), 0px 24px 38px 3px var(--jp-shadow-penumbra-color), 0px 9px 46px 8px var(--jp-shadow-ambient-color);--jp-border-width: 1px;--jp-border-color0: var(--md-grey-400);--jp-border-color1: var(--md-grey-400);--jp-border-color2: var(--md-grey-300);--jp-border-color3: var(--md-grey-200);--jp-inverse-border-color: var(--md-grey-600);--jp-border-radius: 2px;--jp-ui-font-scale-factor: 1.2;--jp-ui-font-size0: .83333em;--jp-ui-font-size1: 13px;--jp-ui-font-size2: 1.2em;--jp-ui-font-size3: 1.44em;--jp-ui-font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";--jp-ui-font-color0: rgba(0, 0, 0, 1);--jp-ui-font-color1: rgba(0, 0, 0, .87);--jp-ui-font-color2: rgba(0, 0, 0, .54);--jp-ui-font-color3: rgba(0, 0, 0, .38);--jp-ui-inverse-font-color0: rgba(255, 255, 255, 1);--jp-ui-inverse-font-color1: rgba(255, 255, 255, 1);--jp-ui-inverse-font-color2: rgba(255, 255, 255, .7);--jp-ui-inverse-font-color3: rgba(255, 255, 255, .5);--jp-content-line-height: 1.6;--jp-content-font-scale-factor: 1.2;--jp-content-font-size0: .83333em;--jp-content-font-size1: 14px;--jp-content-font-size2: 1.2em;--jp-content-font-size3: 1.44em;--jp-content-font-size4: 1.728em;--jp-content-font-size5: 2.0736em;--jp-content-presentation-font-size1: 17px;--jp-content-heading-line-height: 1;--jp-content-heading-margin-top: 1.2em;--jp-content-heading-margin-bottom: .8em;--jp-content-heading-font-weight: 500;--jp-content-font-color0: rgba(0, 0, 0, 1);--jp-content-font-color1: rgba(0, 0, 0, .87);--jp-content-font-color2: rgba(0, 0, 0, .54);--jp-content-font-color3: rgba(0, 0, 0, .38);--jp-content-link-color: var(--md-blue-700);--jp-content-font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";--jp-code-font-size: 13px;--jp-code-line-height: 1.3077;--jp-code-padding: 5px;--jp-code-font-family-default: Menlo, Consolas, "DejaVu Sans Mono", monospace;--jp-code-font-family: var(--jp-code-font-family-default);--jp-code-presentation-font-size: 16px;--jp-code-cursor-width0: 1.4px;--jp-code-cursor-width1: 2px;--jp-code-cursor-width2: 4px;--jp-layout-color0: white;--jp-layou
< / style >
<!-- Load mathjax -->
< script src = "" > < / script >
<!-- MathJax configuration -->
< script type = "text/x-mathjax-config" >
init_mathjax = function() {
if (window.MathJax) {
// MathJax loaded
MathJax.Hub.Config({
TeX: {
equationNumbers: {
autoNumber: "AMS",
useLabelIds: true
}
},
tex2jax: {
inlineMath: [ ['$','$'], ["\\(","\\)"] ],
displayMath: [ ['$$','$$'], ["\\[","\\]"] ],
processEscapes: true,
processEnvironments: true
},
displayAlign: 'center',
2025-01-16 00:41:24 +00:00
messageStyle: 'none',
2024-12-06 01:52:52 +00:00
CommonHTML: {
linebreaks: {
automatic: true
}
}
});
MathJax.Hub.Queue(["Typeset", MathJax.Hub]);
}
}
init_mathjax();
< / script >
<!-- End of mathjax configuration --> < script type = "module" >
document.addEventListener("DOMContentLoaded", async () => {
const diagrams = document.querySelectorAll(".jp-Mermaid > pre.mermaid");
// do not load mermaidjs if not needed
if (!diagrams.length) {
return;
}
const mermaid = (await import("https://cdnjs.cloudflare.com/ajax/libs/mermaid/10.7.0/mermaid.esm.min.mjs")).default;
const parser = new DOMParser();
mermaid.initialize({
maxTextSize: 100000,
maxEdges: 100000,
startOnLoad: false,
fontFamily: window
.getComputedStyle(document.body)
.getPropertyValue("--jp-ui-font-family"),
theme: document.querySelector("body[data-jp-theme-light='true']")
? "default"
: "dark",
});
let _nextMermaidId = 0;
function makeMermaidImage(svg) {
const img = document.createElement("img");
const doc = parser.parseFromString(svg, "image/svg+xml");
const svgEl = doc.querySelector("svg");
const { maxWidth } = svgEl?.style || {};
const firstTitle = doc.querySelector("title");
const firstDesc = doc.querySelector("desc");
img.setAttribute("src", `data:image/svg+xml,${encodeURIComponent(svg)}`);
if (maxWidth) {
img.width = parseInt(maxWidth);
}
if (firstTitle) {
img.setAttribute("alt", firstTitle.textContent);
}
if (firstDesc) {
const caption = document.createElement("figcaption");
caption.className = "sr-only";
caption.textContent = firstDesc.textContent;
return [img, caption];
}
return [img];
}
async function makeMermaidError(text) {
let errorMessage = "";
try {
await mermaid.parse(text);
} catch (err) {
errorMessage = `${err}`;
}
const result = document.createElement("details");
result.className = 'jp-RenderedMermaid-Details';
const summary = document.createElement("summary");
summary.className = 'jp-RenderedMermaid-Summary';
const pre = document.createElement("pre");
const code = document.createElement("code");
code.innerText = text;
pre.appendChild(code);
summary.appendChild(pre);
result.appendChild(summary);
const warning = document.createElement("pre");
warning.innerText = errorMessage;
result.appendChild(warning);
return [result];
}
async function renderOneMarmaid(src) {
const id = `jp-mermaid-${_nextMermaidId++}`;
const parent = src.parentNode;
let raw = src.textContent.trim();
const el = document.createElement("div");
el.style.visibility = "hidden";
document.body.appendChild(el);
let results = null;
let output = null;
try {
let { svg } = await mermaid.render(id, raw, el);
svg = cleanMermaidSvg(svg);
results = makeMermaidImage(svg);
output = document.createElement("figure");
results.map(output.appendChild, output);
} catch (err) {
parent.classList.add("jp-mod-warning");
results = await makeMermaidError(raw);
output = results[0];
} finally {
el.remove();
}
parent.classList.add("jp-RenderedMermaid");
parent.appendChild(output);
}
/**
* Post-process to ensure mermaid diagrams contain only valid SVG and XHTML.
*/
function cleanMermaidSvg(svg) {
return svg.replace(RE_VOID_ELEMENT, replaceVoidElement);
}
/**
* A regular expression for all void elements, which may include attributes and
* a slash.
*
* @see https://developer.mozilla.org/en-US/docs/Glossary/Void_element
*
* Of these, only `< br > ` is generated by Mermaid in place of `\n`,
* but _any_ "malformed" tag will break the SVG rendering entirely.
*/
const RE_VOID_ELEMENT =
/< \s*(area|base|br|col|embed|hr|img|input|link|meta|param|source|track|wbr)\s*([^>]*?)\s*>/gi;
/**
* Ensure a void element is closed with a slash, preserving any attributes.
*/
function replaceVoidElement(match, tag, rest) {
rest = rest.trim();
if (!rest.endsWith('/')) {
rest = `${rest} /`;
}
return `< ${tag} ${rest}>`;
}
void Promise.all([...diagrams].map(renderOneMarmaid));
});
< / script >
< style >
.jp-Mermaid:not(.jp-RenderedMermaid) {
display: none;
}
.jp-RenderedMermaid {
overflow: auto;
display: flex;
}
.jp-RenderedMermaid.jp-mod-warning {
width: auto;
padding: 0.5em;
margin-top: 0.5em;
border: var(--jp-border-width) solid var(--jp-warn-color2);
border-radius: var(--jp-border-radius);
color: var(--jp-ui-font-color1);
font-size: var(--jp-ui-font-size1);
white-space: pre-wrap;
word-wrap: break-word;
}
.jp-RenderedMermaid figure {
margin: 0;
overflow: auto;
max-width: 100%;
}
.jp-RenderedMermaid img {
max-width: 100%;
}
.jp-RenderedMermaid-Details > pre {
margin-top: 1em;
}
.jp-RenderedMermaid-Summary {
color: var(--jp-warn-color2);
}
.jp-RenderedMermaid:not(.jp-mod-warning) pre {
display: none;
}
.jp-RenderedMermaid-Summary > pre {
display: inline-block;
white-space: normal;
}
< / style >
<!-- End of mermaid configuration --> < div class = "jupyter-wrapper" >
< div class = "jp-Notebook" data-jp-theme-light = "true" data-jp-theme-name = "JupyterLab Light" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-1" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "c1" > # Copyright (c) 2024 Microsoft Corporation.< / span >
< span class = "c1" > # Licensed under the MIT License.< / span >
< / pre > < / div >
< div class = "clipboard-copy-txt" id = "cell-1" > # Copyright (c) 2024 Microsoft Corporation.
# Licensed under the MIT License.< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< h2 id = "api-overview" > API Overview< a class = "anchor-link" href = "#api-overview" > ¶< / a > < / h2 > < p > This notebook provides a demonstration of how to interact with graphrag as a library using the API as opposed to the CLI. Note that graphrag's CLI actually connects to the library through this API for all operations.< / p >
< / div >
< / div >
< / div >
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-2" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
2025-03-12 00:26:37 +00:00
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "kn" > from< / span > < span class = "w" > < / span > < span class = "nn" > pathlib< / span > < span class = "w" > < / span > < span class = "kn" > import< / span > < span class = "n" > Path< / span >
< span class = "kn" > from< / span > < span class = "w" > < / span > < span class = "nn" > pprint< / span > < span class = "w" > < / span > < span class = "kn" > import< / span > < span class = "n" > pprint< / span >
< span class = "kn" > import< / span > < span class = "w" > < / span > < span class = "nn" > pandas< / span > < span class = "w" > < / span > < span class = "k" > as< / span > < span class = "w" > < / span > < span class = "nn" > pd< / span >
< span class = "kn" > import< / span > < span class = "w" > < / span > < span class = "nn" > graphrag.api< / span > < span class = "w" > < / span > < span class = "k" > as< / span > < span class = "w" > < / span > < span class = "nn" > api< / span >
< span class = "kn" > from< / span > < span class = "w" > < / span > < span class = "nn" > graphrag.config.load_config< / span > < span class = "w" > < / span > < span class = "kn" > import< / span > < span class = "n" > load_config< / span >
< span class = "kn" > from< / span > < span class = "w" > < / span > < span class = "nn" > graphrag.index.typing.pipeline_run_result< / span > < span class = "w" > < / span > < span class = "kn" > import< / span > < span class = "n" > PipelineRunResult< / span >
2024-12-06 01:52:52 +00:00
< / pre > < / div >
2025-03-12 00:26:37 +00:00
< div class = "clipboard-copy-txt" id = "cell-2" > from pathlib import Path
from pprint import pprint
import pandas as pd
import graphrag.api as api
from graphrag.config.load_config import load_config
from graphrag.index.typing.pipeline_run_result import PipelineRunResult< / div >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell-outputWrapper" >
< div class = "jp-Collapser jp-OutputCollapser jp-Cell-outputCollapser" >
< / div >
< div class = "jp-OutputArea jp-Cell-outputArea" >
< div class = "jp-OutputArea-child" >
< div class = "jp-OutputPrompt jp-OutputArea-prompt" > < / div >
< div class = "jp-RenderedText jp-OutputArea-output" data-mime-type = "text/plain" tabindex = "0" >
< pre >
< / pre >
< / div >
< / div >
2025-02-25 23:09:37 +00:00
< / div >
< / div >
2024-12-06 01:52:52 +00:00
< / div >
2025-03-12 00:26:37 +00:00
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell jp-mod-noOutputs" >
2024-12-06 01:52:52 +00:00
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-3" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
2025-03-12 00:26:37 +00:00
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "n" > PROJECT_DIRECTORY< / span > < span class = "o" > =< / span > < span class = "s2" > "< your project directory> "< / span >
2024-12-06 01:52:52 +00:00
< / pre > < / div >
2025-03-12 00:26:37 +00:00
< div class = "clipboard-copy-txt" id = "cell-3" > PROJECT_DIRECTORY = "< your directory = "" project = "" > "< / your > < / div >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
2025-03-12 00:26:37 +00:00
< h2 id = "prerequisite" > Prerequisite< a class = "anchor-link" href = "#prerequisite" > ¶< / a > < / h2 > < p > As a prerequisite to all API operations, a < code > GraphRagConfig< / code > object is required. It is the primary means to control the behavior of graphrag and can be instantiated from a < code > settings.yaml< / code > configuration file.< / p >
< p > Please refer to the < a href = "https://microsoft.github.io/graphrag/cli/#init" > CLI docs< / a > for more detailed information on how to generate the < code > settings.yaml< / code > file.< / p >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< h3 id = "generate-a-graphragconfig-object" > Generate a < code > GraphRagConfig< / code > object< a class = "anchor-link" href = "#generate-a-graphragconfig-object" > ¶< / a > < / h3 >
< / div >
< / div >
< / div >
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-4" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
2025-03-12 00:26:37 +00:00
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "n" > graphrag_config< / span > < span class = "o" > =< / span > < span class = "n" > load_config< / span > < span class = "p" > (< / span > < span class = "n" > Path< / span > < span class = "p" > (< / span > < span class = "n" > PROJECT_DIRECTORY< / span > < span class = "p" > ))< / span >
2024-12-06 01:52:52 +00:00
< / pre > < / div >
2025-03-12 00:26:37 +00:00
< div class = "clipboard-copy-txt" id = "cell-4" > graphrag_config = load_config(Path(PROJECT_DIRECTORY))< / div >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell-outputWrapper" >
< div class = "jp-Collapser jp-OutputCollapser jp-Cell-outputCollapser" >
< / div >
< div class = "jp-OutputArea jp-Cell-outputArea" >
< div class = "jp-OutputArea-child" >
< div class = "jp-OutputPrompt jp-OutputArea-prompt" > < / div >
< div class = "jp-RenderedText jp-OutputArea-output" data-mime-type = "application/vnd.jupyter.stderr" tabindex = "0" >
< pre >
< span class = "ansi-red-fg" > ---------------------------------------------------------------------------< / span >
2025-03-12 00:26:37 +00:00
< span class = "ansi-red-fg" > FileNotFoundError< / span > Traceback (most recent call last)
Cell < span class = "ansi-green-fg" > In[4], line 1< / span >
< span class = "ansi-green-fg" > ----> 1< / span > graphrag_config < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > load_config< / span > < span class = "ansi-yellow-bg" > (< / span > < span class = "ansi-yellow-bg" > Path< / span > < span class = "ansi-yellow-bg" > (< / span > < span class = "ansi-yellow-bg" > PROJECT_DIRECTORY< / span > < span class = "ansi-yellow-bg" > )< / span > < span class = "ansi-yellow-bg" > )< / span >
2024-12-06 01:52:52 +00:00
2025-03-12 00:26:37 +00:00
File < span class = "ansi-green-fg" > ~/work/graphrag/graphrag/graphrag/config/load_config.py:183< / span > , in < span class = "ansi-cyan-fg" > load_config< / span > < span class = "ansi-blue-fg" > (root_dir, config_filepath, cli_overrides)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 151< / span > < span style = "color: rgb(175,0,0)" > """Load configuration from a file.< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 152< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 153< / span > < span style = "color: rgb(175,0,0)" > Parameters< / span >
< span class = "ansi-green-fg" > (...)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 180< / span > < span style = "color: rgb(175,0,0)" > If there are pydantic validation errors when instantiating the config.< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 181< / span > < span style = "color: rgb(175,0,0)" > """< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 182< / span > root < span style = "color: rgb(98,98,98)" > =< / span > root_dir< span style = "color: rgb(98,98,98)" > .< / span > resolve()
< span class = "ansi-green-fg" > --> 183< / span > config_path < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > _get_config_path< / span > < span class = "ansi-yellow-bg" > (< / span > < span class = "ansi-yellow-bg" > root< / span > < span class = "ansi-yellow-bg" > ,< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > config_filepath< / span > < span class = "ansi-yellow-bg" > )< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 184< / span > _load_dotenv(config_path)
< span class = "ansi-green-intense-fg ansi-bold" > 185< / span > config_extension < span style = "color: rgb(98,98,98)" > =< / span > config_path< span style = "color: rgb(98,98,98)" > .< / span > suffix
File < span class = "ansi-green-fg" > ~/work/graphrag/graphrag/graphrag/config/load_config.py:106< / span > , in < span class = "ansi-cyan-fg" > _get_config_path< / span > < span class = "ansi-blue-fg" > (root_dir, config_filepath)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 104< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > raise< / span > < span class = "ansi-bold" style = "color: rgb(215,95,95)" > FileNotFoundError< / span > (msg)
< span class = "ansi-green-intense-fg ansi-bold" > 105< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > else< / span > :
< span class = "ansi-green-fg" > --> 106< / span > config_path < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > _search_for_config_in_root_dir< / span > < span class = "ansi-yellow-bg" > (< / span > < span class = "ansi-yellow-bg" > root_dir< / span > < span class = "ansi-yellow-bg" > )< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 108< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > if< / span > < span class = "ansi-bold" style = "color: rgb(175,0,255)" > not< / span > config_path:
< span class = "ansi-green-intense-fg ansi-bold" > 109< / span > msg < span style = "color: rgb(98,98,98)" > =< / span > < span style = "color: rgb(175,0,0)" > f< / span > < span style = "color: rgb(175,0,0)" > "< / span > < span style = "color: rgb(175,0,0)" > Config file not found in root directory: < / span > < span class = "ansi-bold" style = "color: rgb(175,95,135)" > {< / span > root_dir< span class = "ansi-bold" style = "color: rgb(175,95,135)" > }< / span > < span style = "color: rgb(175,0,0)" > "< / span >
File < span class = "ansi-green-fg" > ~/work/graphrag/graphrag/graphrag/config/load_config.py:40< / span > , in < span class = "ansi-cyan-fg" > _search_for_config_in_root_dir< / span > < span class = "ansi-blue-fg" > (root)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 38< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > if< / span > < span class = "ansi-bold" style = "color: rgb(175,0,255)" > not< / span > root< span style = "color: rgb(98,98,98)" > .< / span > is_dir():
< span class = "ansi-green-intense-fg ansi-bold" > 39< / span > msg < span style = "color: rgb(98,98,98)" > =< / span > < span style = "color: rgb(175,0,0)" > f< / span > < span style = "color: rgb(175,0,0)" > "< / span > < span style = "color: rgb(175,0,0)" > Invalid config path: < / span > < span class = "ansi-bold" style = "color: rgb(175,95,135)" > {< / span > root< span class = "ansi-bold" style = "color: rgb(175,95,135)" > }< / span > < span style = "color: rgb(175,0,0)" > is not a directory< / span > < span style = "color: rgb(175,0,0)" > "< / span >
< span class = "ansi-green-fg" > ---> 40< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > raise< / span > < span class = "ansi-bold" style = "color: rgb(215,95,95)" > FileNotFoundError< / span > (msg)
< span class = "ansi-green-intense-fg ansi-bold" > 42< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > for< / span > file < span class = "ansi-bold" style = "color: rgb(175,0,255)" > in< / span > _default_config_files:
< span class = "ansi-green-intense-fg ansi-bold" > 43< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > if< / span > (root < span style = "color: rgb(98,98,98)" > /< / span > file)< span style = "color: rgb(98,98,98)" > .< / span > is_file():
< span class = "ansi-red-fg" > FileNotFoundError< / span > : Invalid config path: /home/runner/work/graphrag/graphrag/docs/examples_notebooks/< your project directory> is not a directory< / pre >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< h2 id = "indexing-api" > Indexing API< a class = "anchor-link" href = "#indexing-api" > ¶< / a > < / h2 > < p > < em > Indexing< / em > is the process of ingesting raw text data and constructing a knowledge graph. GraphRAG currently supports plaintext (< code > .txt< / code > ) and < code > .csv< / code > file formats.< / p >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< h2 id = "build-an-index" > Build an index< a class = "anchor-link" href = "#build-an-index" > ¶< / a > < / h2 >
< / div >
< / div >
< / div >
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-5" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "n" > index_result< / span > < span class = "p" > :< / span > < span class = "nb" > list< / span > < span class = "p" > [< / span > < span class = "n" > PipelineRunResult< / span > < span class = "p" > ]< / span > < span class = "o" > =< / span > < span class = "k" > await< / span > < span class = "n" > api< / span > < span class = "o" > .< / span > < span class = "n" > build_index< / span > < span class = "p" > (< / span > < span class = "n" > config< / span > < span class = "o" > =< / span > < span class = "n" > graphrag_config< / span > < span class = "p" > )< / span >
< span class = "c1" > # index_result is a list of workflows that make up the indexing pipeline that was run< / span >
< span class = "k" > for< / span > < span class = "n" > workflow_result< / span > < span class = "ow" > in< / span > < span class = "n" > index_result< / span > < span class = "p" > :< / span >
< span class = "n" > status< / span > < span class = "o" > =< / span > < span class = "sa" > f< / span > < span class = "s2" > "error< / span > < span class = "se" > \n< / span > < span class = "si" > {< / span > < span class = "n" > workflow_result< / span > < span class = "o" > .< / span > < span class = "n" > errors< / span > < span class = "si" > }< / span > < span class = "s2" > "< / span > < span class = "k" > if< / span > < span class = "n" > workflow_result< / span > < span class = "o" > .< / span > < span class = "n" > errors< / span > < span class = "k" > else< / span > < span class = "s2" > "success"< / span >
< span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "sa" > f< / span > < span class = "s2" > "Workflow Name: < / span > < span class = "si" > {< / span > < span class = "n" > workflow_result< / span > < span class = "o" > .< / span > < span class = "n" > workflow< / span > < span class = "si" > }< / span > < span class = "se" > \t< / span > < span class = "s2" > Status: < / span > < span class = "si" > {< / span > < span class = "n" > status< / span > < span class = "si" > }< / span > < span class = "s2" > "< / span > < span class = "p" > )< / span >
< / pre > < / div >
< div class = "clipboard-copy-txt" id = "cell-5" > index_result: list[PipelineRunResult] = await api.build_index(config=graphrag_config)
# index_result is a list of workflows that make up the indexing pipeline that was run
for workflow_result in index_result:
status = f"error\n{workflow_result.errors}" if workflow_result.errors else "success"
print(f"Workflow Name: {workflow_result.workflow}\tStatus: {status}")< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell-outputWrapper" >
< div class = "jp-Collapser jp-OutputCollapser jp-Cell-outputCollapser" >
< / div >
< div class = "jp-OutputArea jp-Cell-outputArea" >
< div class = "jp-OutputArea-child" >
< div class = "jp-OutputPrompt jp-OutputArea-prompt" > < / div >
< div class = "jp-RenderedText jp-OutputArea-output" data-mime-type = "application/vnd.jupyter.stderr" tabindex = "0" >
< pre >
< span class = "ansi-red-fg" > ---------------------------------------------------------------------------< / span >
< span class = "ansi-red-fg" > NameError< / span > Traceback (most recent call last)
Cell < span class = "ansi-green-fg" > In[5], line 1< / span >
< span class = "ansi-green-fg" > ----> 1< / span > index_result: < span style = "color: rgb(0,135,0)" > list< / span > [PipelineRunResult] < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > await< / span > api< span style = "color: rgb(98,98,98)" > .< / span > build_index(config< span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > graphrag_config< / span > )
< span class = "ansi-green-intense-fg ansi-bold" > 3< / span > < span style = "color: rgb(95,135,135)" > # index_result is a list of workflows that make up the indexing pipeline that was run< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 4< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > for< / span > workflow_result < span class = "ansi-bold" style = "color: rgb(175,0,255)" > in< / span > index_result:
< span class = "ansi-red-fg" > NameError< / span > : name 'graphrag_config' is not defined< / pre >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< h2 id = "query-an-index" > Query an index< a class = "anchor-link" href = "#query-an-index" > ¶< / a > < / h2 > < p > To query an index, several index files must first be read into memory and passed to the query API.< / p >
< / div >
< / div >
< / div >
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-6" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
2025-03-12 00:26:37 +00:00
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "n" > entities< / span > < span class = "o" > =< / span > < span class = "n" > pd< / span > < span class = "o" > .< / span > < span class = "n" > read_parquet< / span > < span class = "p" > (< / span > < span class = "sa" > f< / span > < span class = "s2" > "< / span > < span class = "si" > {< / span > < span class = "n" > PROJECT_DIRECTORY< / span > < span class = "si" > }< / span > < span class = "s2" > /output/entities.parquet"< / span > < span class = "p" > )< / span >
< span class = "n" > communities< / span > < span class = "o" > =< / span > < span class = "n" > pd< / span > < span class = "o" > .< / span > < span class = "n" > read_parquet< / span > < span class = "p" > (< / span > < span class = "sa" > f< / span > < span class = "s2" > "< / span > < span class = "si" > {< / span > < span class = "n" > PROJECT_DIRECTORY< / span > < span class = "si" > }< / span > < span class = "s2" > /output/communities.parquet"< / span > < span class = "p" > )< / span >
< span class = "n" > community_reports< / span > < span class = "o" > =< / span > < span class = "n" > pd< / span > < span class = "o" > .< / span > < span class = "n" > read_parquet< / span > < span class = "p" > (< / span >
2025-02-10 19:03:00 +00:00
< span class = "sa" > f< / span > < span class = "s2" > "< / span > < span class = "si" > {< / span > < span class = "n" > PROJECT_DIRECTORY< / span > < span class = "si" > }< / span > < span class = "s2" > /output/community_reports.parquet"< / span >
2024-12-06 01:52:52 +00:00
< span class = "p" > )< / span >
< span class = "n" > response< / span > < span class = "p" > ,< / span > < span class = "n" > context< / span > < span class = "o" > =< / span > < span class = "k" > await< / span > < span class = "n" > api< / span > < span class = "o" > .< / span > < span class = "n" > global_search< / span > < span class = "p" > (< / span >
< span class = "n" > config< / span > < span class = "o" > =< / span > < span class = "n" > graphrag_config< / span > < span class = "p" > ,< / span >
2025-03-12 00:26:37 +00:00
< span class = "n" > entities< / span > < span class = "o" > =< / span > < span class = "n" > entities< / span > < span class = "p" > ,< / span >
< span class = "n" > communities< / span > < span class = "o" > =< / span > < span class = "n" > communities< / span > < span class = "p" > ,< / span >
< span class = "n" > community_reports< / span > < span class = "o" > =< / span > < span class = "n" > community_reports< / span > < span class = "p" > ,< / span >
2024-12-06 01:52:52 +00:00
< span class = "n" > community_level< / span > < span class = "o" > =< / span > < span class = "mi" > 2< / span > < span class = "p" > ,< / span >
< span class = "n" > dynamic_community_selection< / span > < span class = "o" > =< / span > < span class = "kc" > False< / span > < span class = "p" > ,< / span >
< span class = "n" > response_type< / span > < span class = "o" > =< / span > < span class = "s2" > "Multiple Paragraphs"< / span > < span class = "p" > ,< / span >
< span class = "n" > query< / span > < span class = "o" > =< / span > < span class = "s2" > "Who is Scrooge and what are his main relationships?"< / span > < span class = "p" > ,< / span >
< span class = "p" > )< / span >
< / pre > < / div >
2025-03-12 00:26:37 +00:00
< div class = "clipboard-copy-txt" id = "cell-6" > entities = pd.read_parquet(f"{PROJECT_DIRECTORY}/output/entities.parquet")
communities = pd.read_parquet(f"{PROJECT_DIRECTORY}/output/communities.parquet")
community_reports = pd.read_parquet(
2025-02-10 19:03:00 +00:00
f"{PROJECT_DIRECTORY}/output/community_reports.parquet"
2024-12-06 01:52:52 +00:00
)
response, context = await api.global_search(
config=graphrag_config,
2025-03-12 00:26:37 +00:00
entities=entities,
communities=communities,
community_reports=community_reports,
2024-12-06 01:52:52 +00:00
community_level=2,
dynamic_community_selection=False,
response_type="Multiple Paragraphs",
query="Who is Scrooge and what are his main relationships?",
2025-02-10 19:03:00 +00:00
)< / div >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell-outputWrapper" >
< div class = "jp-Collapser jp-OutputCollapser jp-Cell-outputCollapser" >
< / div >
< div class = "jp-OutputArea jp-Cell-outputArea" >
< div class = "jp-OutputArea-child" >
< div class = "jp-OutputPrompt jp-OutputArea-prompt" > < / div >
< div class = "jp-RenderedText jp-OutputArea-output" data-mime-type = "application/vnd.jupyter.stderr" tabindex = "0" >
< pre >
< span class = "ansi-red-fg" > ---------------------------------------------------------------------------< / span >
< span class = "ansi-red-fg" > FileNotFoundError< / span > Traceback (most recent call last)
2025-03-12 00:26:37 +00:00
Cell < span class = "ansi-green-fg" > In[6], line 1< / span >
< span class = "ansi-green-fg" > ----> 1< / span > entities < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > pd< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > .< / span > < span class = "ansi-yellow-bg" > read_parquet< / span > < span class = "ansi-yellow-bg" > (< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > f< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > "< / span > < span class = "ansi-yellow-bg ansi-bold" style = "color: rgb(175,95,135)" > {< / span > < span class = "ansi-yellow-bg" > PROJECT_DIRECTORY< / span > < span class = "ansi-yellow-bg ansi-bold" style = "color: rgb(175,95,135)" > }< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > /output/entities.parquet< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > "< / span > < span class = "ansi-yellow-bg" > )< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 2< / span > communities < span style = "color: rgb(98,98,98)" > =< / span > pd< span style = "color: rgb(98,98,98)" > .< / span > read_parquet(< span style = "color: rgb(175,0,0)" > f< / span > < span style = "color: rgb(175,0,0)" > "< / span > < span class = "ansi-bold" style = "color: rgb(175,95,135)" > {< / span > PROJECT_DIRECTORY< span class = "ansi-bold" style = "color: rgb(175,95,135)" > }< / span > < span style = "color: rgb(175,0,0)" > /output/communities.parquet< / span > < span style = "color: rgb(175,0,0)" > "< / span > )
< span class = "ansi-green-intense-fg ansi-bold" > 3< / span > community_reports < span style = "color: rgb(98,98,98)" > =< / span > pd< span style = "color: rgb(98,98,98)" > .< / span > read_parquet(
< span class = "ansi-green-intense-fg ansi-bold" > 4< / span > < span style = "color: rgb(175,0,0)" > f< / span > < span style = "color: rgb(175,0,0)" > "< / span > < span class = "ansi-bold" style = "color: rgb(175,95,135)" > {< / span > PROJECT_DIRECTORY< span class = "ansi-bold" style = "color: rgb(175,95,135)" > }< / span > < span style = "color: rgb(175,0,0)" > /output/community_reports.parquet< / span > < span style = "color: rgb(175,0,0)" > "< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 5< / span > )
2024-12-06 01:52:52 +00:00
File < span class = "ansi-green-fg" > ~/.cache/pypoetry/virtualenvs/graphrag-F2jvqev7-py3.11/lib/python3.11/site-packages/pandas/io/parquet.py:667< / span > , in < span class = "ansi-cyan-fg" > read_parquet< / span > < span class = "ansi-blue-fg" > (path, engine, columns, storage_options, use_nullable_dtypes, dtype_backend, filesystem, filters, **kwargs)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 664< / span > use_nullable_dtypes < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > False< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 665< / span > check_dtype_backend(dtype_backend)
< span class = "ansi-green-fg" > --> 667< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > return< / span > < span class = "ansi-yellow-bg" > impl< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > .< / span > < span class = "ansi-yellow-bg" > read< / span > < span class = "ansi-yellow-bg" > (< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 668< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > path< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 669< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > columns< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > columns< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 670< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > filters< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > filters< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 671< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > storage_options< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > storage_options< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 672< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > use_nullable_dtypes< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > use_nullable_dtypes< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 673< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > dtype_backend< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > dtype_backend< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 674< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > filesystem< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > filesystem< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 675< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > *< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > *< / span > < span class = "ansi-yellow-bg" > kwargs< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 676< / span > < span class = "ansi-yellow-bg" > )< / span >
File < span class = "ansi-green-fg" > ~/.cache/pypoetry/virtualenvs/graphrag-F2jvqev7-py3.11/lib/python3.11/site-packages/pandas/io/parquet.py:267< / span > , in < span class = "ansi-cyan-fg" > PyArrowImpl.read< / span > < span class = "ansi-blue-fg" > (self, path, columns, filters, use_nullable_dtypes, dtype_backend, storage_options, filesystem, **kwargs)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 264< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > if< / span > manager < span style = "color: rgb(98,98,98)" > ==< / span > < span style = "color: rgb(175,0,0)" > "< / span > < span style = "color: rgb(175,0,0)" > array< / span > < span style = "color: rgb(175,0,0)" > "< / span > :
< span class = "ansi-green-intense-fg ansi-bold" > 265< / span > to_pandas_kwargs[< span style = "color: rgb(175,0,0)" > "< / span > < span style = "color: rgb(175,0,0)" > split_blocks< / span > < span style = "color: rgb(175,0,0)" > "< / span > ] < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > True< / span > < span style = "color: rgb(95,135,135)" > # type: ignore[assignment]< / span >
< span class = "ansi-green-fg" > --> 267< / span > path_or_handle, handles, filesystem < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > _get_path_or_handle< / span > < span class = "ansi-yellow-bg" > (< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 268< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > path< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 269< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > filesystem< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 270< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > storage_options< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > storage_options< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 271< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > mode< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > "< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > rb< / span > < span class = "ansi-yellow-bg" style = "color: rgb(175,0,0)" > "< / span > < span class = "ansi-yellow-bg" > ,< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 272< / span > < span class = "ansi-yellow-bg" > )< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 273< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > try< / span > :
< span class = "ansi-green-intense-fg ansi-bold" > 274< / span > pa_table < span style = "color: rgb(98,98,98)" > =< / span > < span style = "color: rgb(0,135,0)" > self< / span > < span style = "color: rgb(98,98,98)" > .< / span > api< span style = "color: rgb(98,98,98)" > .< / span > parquet< span style = "color: rgb(98,98,98)" > .< / span > read_table(
< span class = "ansi-green-intense-fg ansi-bold" > 275< / span > path_or_handle,
< span class = "ansi-green-intense-fg ansi-bold" > 276< / span > columns< span style = "color: rgb(98,98,98)" > =< / span > columns,
< span class = "ansi-green-fg" > (...)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 279< / span > < span style = "color: rgb(98,98,98)" > *< / span > < span style = "color: rgb(98,98,98)" > *< / span > kwargs,
< span class = "ansi-green-intense-fg ansi-bold" > 280< / span > )
File < span class = "ansi-green-fg" > ~/.cache/pypoetry/virtualenvs/graphrag-F2jvqev7-py3.11/lib/python3.11/site-packages/pandas/io/parquet.py:140< / span > , in < span class = "ansi-cyan-fg" > _get_path_or_handle< / span > < span class = "ansi-blue-fg" > (path, fs, storage_options, mode, is_dir)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 130< / span > handles < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > None< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 131< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > if< / span > (
< span class = "ansi-green-intense-fg ansi-bold" > 132< / span > < span class = "ansi-bold" style = "color: rgb(175,0,255)" > not< / span > fs
< span class = "ansi-green-intense-fg ansi-bold" > 133< / span > < span class = "ansi-bold" style = "color: rgb(175,0,255)" > and< / span > < span class = "ansi-bold" style = "color: rgb(175,0,255)" > not< / span > is_dir
< span class = "ansi-green-fg" > (...)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 138< / span > < span style = "color: rgb(95,135,135)" > # fsspec resources can also point to directories< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 139< / span > < span style = "color: rgb(95,135,135)" > # this branch is used for example when reading from non-fsspec URLs< / span >
< span class = "ansi-green-fg" > --> 140< / span > handles < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > get_handle< / span > < span class = "ansi-yellow-bg" > (< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 141< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > path_or_handle< / span > < span class = "ansi-yellow-bg" > ,< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > mode< / span > < span class = "ansi-yellow-bg" > ,< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > is_text< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg ansi-bold" style = "color: rgb(0,135,0)" > False< / span > < span class = "ansi-yellow-bg" > ,< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > storage_options< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" > storage_options< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 142< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > )< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 143< / span > fs < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > None< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 144< / span > path_or_handle < span style = "color: rgb(98,98,98)" > =< / span > handles< span style = "color: rgb(98,98,98)" > .< / span > handle
File < span class = "ansi-green-fg" > ~/.cache/pypoetry/virtualenvs/graphrag-F2jvqev7-py3.11/lib/python3.11/site-packages/pandas/io/common.py:882< / span > , in < span class = "ansi-cyan-fg" > get_handle< / span > < span class = "ansi-blue-fg" > (path_or_buf, mode, encoding, compression, memory_map, is_text, errors, storage_options)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 873< / span > handle < span style = "color: rgb(98,98,98)" > =< / span > < span style = "color: rgb(0,135,0)" > open< / span > (
< span class = "ansi-green-intense-fg ansi-bold" > 874< / span > handle,
< span class = "ansi-green-intense-fg ansi-bold" > 875< / span > ioargs< span style = "color: rgb(98,98,98)" > .< / span > mode,
< span class = "ansi-green-fg" > (...)< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 878< / span > newline< span style = "color: rgb(98,98,98)" > =< / span > < span style = "color: rgb(175,0,0)" > "< / span > < span style = "color: rgb(175,0,0)" > "< / span > ,
< span class = "ansi-green-intense-fg ansi-bold" > 879< / span > )
< span class = "ansi-green-intense-fg ansi-bold" > 880< / span > < span class = "ansi-bold" style = "color: rgb(0,135,0)" > else< / span > :
< span class = "ansi-green-intense-fg ansi-bold" > 881< / span > < span style = "color: rgb(95,135,135)" > # Binary mode< / span >
< span class = "ansi-green-fg" > --> 882< / span > handle < span style = "color: rgb(98,98,98)" > =< / span > < span class = "ansi-yellow-bg" style = "color: rgb(0,135,0)" > open< / span > < span class = "ansi-yellow-bg" > (< / span > < span class = "ansi-yellow-bg" > handle< / span > < span class = "ansi-yellow-bg" > ,< / span > < span class = "ansi-yellow-bg" > < / span > < span class = "ansi-yellow-bg" > ioargs< / span > < span class = "ansi-yellow-bg" style = "color: rgb(98,98,98)" > .< / span > < span class = "ansi-yellow-bg" > mode< / span > < span class = "ansi-yellow-bg" > )< / span >
< span class = "ansi-green-intense-fg ansi-bold" > 883< / span > handles< span style = "color: rgb(98,98,98)" > .< / span > append(handle)
< span class = "ansi-green-intense-fg ansi-bold" > 885< / span > < span style = "color: rgb(95,135,135)" > # Convert BytesIO or file objects passed with an encoding< / span >
2025-03-12 00:26:37 +00:00
< span class = "ansi-red-fg" > FileNotFoundError< / span > : [Errno 2] No such file or directory: '< your project directory> /output/entities.parquet'< / pre >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< p > The response object is the official reponse from graphrag while the context object holds various metadata regarding the querying process used to obtain the final response.< / p >
< / div >
< / div >
< / div >
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-7" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "n" > response< / span > < span class = "p" > )< / span >
< / pre > < / div >
< div class = "clipboard-copy-txt" id = "cell-7" > print(response)< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell-outputWrapper" >
< div class = "jp-Collapser jp-OutputCollapser jp-Cell-outputCollapser" >
< / div >
< div class = "jp-OutputArea jp-Cell-outputArea" >
< div class = "jp-OutputArea-child" >
< div class = "jp-OutputPrompt jp-OutputArea-prompt" > < / div >
< div class = "jp-RenderedText jp-OutputArea-output" data-mime-type = "application/vnd.jupyter.stderr" tabindex = "0" >
< pre >
< span class = "ansi-red-fg" > ---------------------------------------------------------------------------< / span >
< span class = "ansi-red-fg" > NameError< / span > Traceback (most recent call last)
Cell < span class = "ansi-green-fg" > In[7], line 1< / span >
< span class = "ansi-green-fg" > ----> 1< / span > < span style = "color: rgb(0,135,0)" > print< / span > (< span class = "ansi-yellow-bg" > response< / span > )
< span class = "ansi-red-fg" > NameError< / span > : name 'response' is not defined< / pre >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell jp-MarkdownCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" > < div class = "jp-InputPrompt jp-InputArea-prompt" >
< / div > < div class = "jp-RenderedHTMLCommon jp-RenderedMarkdown jp-MarkdownOutput" data-mime-type = "text/markdown" >
< p > Digging into the context a bit more provides users with extremely granular information such as what sources of data (down to the level of text chunks) were ultimately retrieved and used as part of the context sent to the LLM model).< / p >
< / div >
< / div >
< / div >
< / div > < div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell jp-CodeCell jp-Notebook-cell" >
< div class = "jp-Cell-inputWrapper" tabindex = "0" >
< div class = "jp-Collapser jp-InputCollapser jp-Cell-inputCollapser" >
< / div >
< div class = "jp-InputArea jp-Cell-inputArea" >
< div class = "jp-InputPrompt jp-InputArea-prompt" > In < / div > < div class = "jp-CodeMirrorEditor jp-Editor jp-InputArea-editor" data-type = "inline" >
< div class = "CodeMirror cm-s-jupyter" >
< div class = "zeroclipboard-container" >
< clipboard-copy , = " " aria-label = "Copy to Clipboard" for = "cell-8" >
< div >
< span class = "notice" hidden = "" > Copied!< / span >
< svg aria-hidden = "true" class = "clipboard-copy-icon" data-view-component = "true" height = "20" version = "1.1" viewbox = "0 0 16 16" width = "20" >
< path d = "M0 6.75C0 5.784.784 5 1.75 5h1.5a.75.75 0 010 1.5h-1.5a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-1.5a.75.75 0 011.5 0v1.5A1.75 1.75 0 019.25 16h-7.5A1.75 1.75 0 010 14.25v-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< path d = "M5 1.75C5 .784 5.784 0 6.75 0h7.5C15.216 0 16 .784 16 1.75v7.5A1.75 1.75 0 0114.25 11h-7.5A1.75 1.75 0 015 9.25v-7.5zm1.75-.25a.25.25 0 00-.25.25v7.5c0 .138.112.25.25.25h7.5a.25.25 0 00.25-.25v-7.5a.25.25 0 00-.25-.25h-7.5z" fill = "currentColor" fill-rule = "evenodd" > < / path >
< / svg >
< / div >
< / clipboard-copy >
< / div >
2025-03-12 00:26:37 +00:00
< div class = "highlight-ipynb hl-python" > < pre > < span > < / span > < span class = "n" > pprint< / span > < span class = "p" > (< / span > < span class = "n" > context< / span > < span class = "p" > )< / span > < span class = "c1" > # noqa: T203< / span >
2024-12-06 01:52:52 +00:00
< / pre > < / div >
2025-03-12 00:26:37 +00:00
< div class = "clipboard-copy-txt" id = "cell-8" > pprint(context) # noqa: T203< / div >
2024-12-06 01:52:52 +00:00
< / div >
< / div >
< / div >
< / div >
< div class = "jp-Cell-outputWrapper" >
< div class = "jp-Collapser jp-OutputCollapser jp-Cell-outputCollapser" >
< / div >
< div class = "jp-OutputArea jp-Cell-outputArea" >
< div class = "jp-OutputArea-child" >
< div class = "jp-OutputPrompt jp-OutputArea-prompt" > < / div >
< div class = "jp-RenderedText jp-OutputArea-output" data-mime-type = "application/vnd.jupyter.stderr" tabindex = "0" >
< pre >
< span class = "ansi-red-fg" > ---------------------------------------------------------------------------< / span >
< span class = "ansi-red-fg" > NameError< / span > Traceback (most recent call last)
2025-03-12 00:26:37 +00:00
Cell < span class = "ansi-green-fg" > In[8], line 1< / span >
< span class = "ansi-green-fg" > ----> 1< / span > pprint(< span class = "ansi-yellow-bg" > context< / span > ) < span style = "color: rgb(95,135,135)" > # noqa: T203< / span >
2024-12-06 01:52:52 +00:00
< span class = "ansi-red-fg" > NameError< / span > : name 'context' is not defined< / pre >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div > <!-- jp - Notebook -->
< / div > <!-- jupyter - wrapper -->
< style >
['pre { line-height: 125%; }\ntd.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }\nspan.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }\ntd.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }\nspan.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }\n.highlight-ipynb .hll { background-color: var(--jp-cell-editor-active-background) }\n.highlight-ipynb { background: var(--jp-cell-editor-background); color: var(--jp-mirror-editor-variable-color) }\n.highlight-ipynb .c { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment */\n.highlight-ipynb .err { color: var(--jp-mirror-editor-error-color) } /* Error */\n.highlight-ipynb .k { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword */\n.highlight-ipynb .o { color: var(--jp-mirror-editor-operator-color); font-weight: bold } /* Operator */\n.highlight-ipynb .p { color: var(--jp-mirror-editor-punctuation-color) } /* Punctuation */\n.highlight-ipynb .ch { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Hashbang */\n.highlight-ipynb .cm { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Multiline */\n.highlight-ipynb .cp { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Preproc */\n.highlight-ipynb .cpf { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.PreprocFile */\n.highlight-ipynb .c1 { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Single */\n.highlight-ipynb .cs { color: var(--jp-mirror-editor-comment-color); font-style: italic } /* Comment.Special */\n.highlight-ipynb .kc { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Constant */\n.highlight-ipynb .kd { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Declaration */\n.highlight-ipynb .kn { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Namespace */\n.highlight-ipynb .kp { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Pseudo */\n.highlight-ipynb .kr { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Reserved */\n.highlight-ipynb .kt { color: var(--jp-mirror-editor-keyword-color); font-weight: bold } /* Keyword.Type */\n.highlight-ipynb .m { color: var(--jp-mirror-editor-number-color) } /* Literal.Number */\n.highlight-ipynb .s { color: var(--jp-mirror-editor-string-color) } /* Literal.String */\n.highlight-ipynb .ow { color: var(--jp-mirror-editor-operator-color); font-weight: bold } /* Operator.Word */\n.highlight-ipynb .pm { color: var(--jp-mirror-editor-punctuation-color) } /* Punctuation.Marker */\n.highlight-ipynb .w { color: var(--jp-mirror-editor-variable-color) } /* Text.Whitespace */\n.highlight-ipynb .mb { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Bin */\n.highlight-ipynb .mf { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Float */\n.highlight-ipynb .mh { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Hex */\n.highlight-ipynb .mi { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Integer */\n.highlight-ipynb .mo { color: var(--jp-mirror-editor-number-color) } /* Literal.Number.Oct */\n.highlight-ipynb .sa { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Affix */\n.highlight-ipynb .sb { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Backtick */\n.highlight-ipynb .sc { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Char */\n.highlight-ipynb .dl { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Delimiter */\n.highlight-ipynb .sd { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Doc */\n.highlight-ipynb .s2 { color: var(--jp-mirror-editor-string-color) } /* Literal.String.Double */\n.highlight-ipynb .se { color:
< / style >
< / 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" >
< 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 >
2025-02-13 21:58:24 +00:00
< script id = "__config" type = "application/json" > { "base" : "../.." , "features" : [ "content.code.copy" , "content.code.select" , "navigation.footer" , "navigation.tabs" ] , "search" : "../../assets/javascripts/workers/search.f8cc74c7.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-12-06 01:52:52 +00:00
2025-03-11 20:56:54 +00:00
< script src = "../../assets/javascripts/bundle.c8b220af.min.js" > < / script >
2024-12-06 01:52:52 +00:00
< script src = "../../scripts/create_cookie_banner.js" > < / script >
< / body >
< / html >
