cocoindex 0.1.82__tar.gz → 0.1.83__tar.gz

{cocoindex-0.1.82 → cocoindex-0.1.83}/Cargo.lock

@@ -1283,7 +1283,7 @@ dependencies = [
 
 [[package]]
 name = "cocoindex"
-version = "0.1.82"
+version = "0.1.83"
 dependencies = [
  "anyhow",
  "async-openai",

{cocoindex-0.1.82 → cocoindex-0.1.83}/Cargo.toml

@@ -2,7 +2,7 @@
 name = "cocoindex"
 # Version used for local development is always higher than others to take precedence.
 # Will be overridden for specific release versions.
-version = "0.1.82"
+version = "0.1.83"
 edition = "2024"
 rust-version = "1.88"
 readme = "README.md"

{cocoindex-0.1.82 → cocoindex-0.1.83}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cocoindex
-Version: 0.1.82
+Version: 0.1.83
 Requires-Dist: click>=8.1.8
 Requires-Dist: rich>=14.0.0
 Requires-Dist: python-dotenv>=1.1.0

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/academic_papers_index.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/academic_papers_index
 canonicalUrl: '/examples/academic_papers_index'
 sidebar_custom_props:
-  image: /img/examples/academic_papers_index.png
+  image: /img/examples/academic_papers_index/cover.png
   tags: [vector-index, metadata]
 tags: [vector-index, metadata]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/codebase_index.md

@@ -5,30 +5,57 @@ sidebar_class_name: hidden
 slug: /examples/code_index
 canonicalUrl: '/examples/code_index'
 sidebar_custom_props:
-  image: /img/examples/codebase_index.png
+  image: /img/examples/codebase_index/cover.png
   tags: [vector-index, codebase]
 tags: [vector-index, codebase]
 ---
 
-import { GitHubButton, YouTubeButton } from '../../../src/components/GitHubButton';
+import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
 
 <GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/code_embedding"/>
 <YouTubeButton url="https://youtu.be/G3WstvhHO24?si=ndYfM0XRs03_hVPR" />
 
-## Setup 
+## Overview
+In this tutorial, we will build codebase index. [CocoIndex](https://github.com/cocoindex-io/cocoindex) provides built-in support for codebase chunking, with native Tree-sitter support. It works with large codebases, and can be updated in near real-time with incremental processing - only reprocess what's changed. 
 
-If you don't have Postgres installed, please follow [installation guide](https://cocoindex.io/docs/getting_started/installation).
+## Use Cases
+A wide range of applications can be built with an effective codebase index that is always up-to-date. Some examples include:
 
-## Add the codebase as a source. 
+![Use case illustration](/img/examples/codebase_index/usecase.png)
+
+- Semantic code context for AI coding agents like Claude, Codex, Gemini CLI.
+- MCP for code editors such as Cursor, Windsurf, and VSCode.
+- Context-aware code search applications—semantic code search, natural language code retrieval.
+- Context for code review agents—AI code review, automated code analysis, code quality checks, pull request summarization.
+- Automated code refactoring, large-scale code migration.
+- Enhance SRE workflows: enable rapid root cause analysis, incident response, and change impact assessment by indexing infrastructure-as-code, deployment scripts, and config files for semantic search and lineage tracking.
+- Automatically generate design documentation from code—keep design docs up-to-date.
+
+## Flow Overview
+
+![Flow Overview](/img/examples/codebase_index/flow.png)
+
+The flow is composed of the following steps:
+
+- Read code files from the local filesystem
+- Extract file extensions, to get the language of the code for Tree-sitter to parse
+- Split code into semantic chunks using Tree-sitter
+- Generate embeddings for each chunk
+- Store in a vector database for retrieval
 
-Ingest files from the CocoIndex codebase root directory.
+## Setup 
+- Install Postgres, follow [installation guide](https://cocoindex.io/docs/getting_started/installation#-install-postgres).
+- Install CocoIndex
+  ```bash
+  pip install -U cocoindex
+  ```
+
+## Add the codebase as a source. 
+We will index the CocoIndex codebase. Here we use the `LocalFile` source to ingest files from the CocoIndex codebase root directory.
 
 ```python
 @cocoindex.flow_def(name="CodeEmbedding")
 def code_embedding_flow(flow_builder: cocoindex.FlowBuilder, data_scope: cocoindex.DataScope):
-    """
-    Define an example flow that embeds files into a vector database.
-    """
     data_scope["files"] = flow_builder.add_source(
         cocoindex.sources.LocalFile(path="../..",
                                     included_patterns=["*.py", "*.rs", "*.toml", "*.md", "*.mdx"],
@@ -40,16 +67,15 @@ def code_embedding_flow(flow_builder: cocoindex.FlowBuilder, data_scope: cocoind
 - Exclude files and directories starting `.`,  `target` in the root and `node_modules` under any directory.
 
 `flow_builder.add_source` will create a table with sub fields (`filename`, `content`). 
-See [documentation](https://cocoindex.io/docs/ops/sources) for more details.
+<DocumentationButton href="https://cocoindex.io/docs/ops/sources" text="Sources" />
 
 
-## Process each file and collect the information.
+## Process each file and collect the information
 
-###  Extract the extension of a filename
+### Extract the extension of a filename
 
 We need to pass the language (or extension) to Tree-sitter to parse the code.
 Let's define a function to extract the extension of a filename while processing each file.
-You can find the documentation for custom function [here](https://cocoindex.io/docs/core/custom_function).
 
 ```python
 @cocoindex.op.function()
@@ -58,52 +84,43 @@ def extract_extension(filename: str) -> str:
     return os.path.splitext(filename)[1]
 ```
 
-Then we are going to process each file and collect the information.
-
-```python
-with data_scope["files"].row() as file:
-    file["extension"] = file["filename"].transform(extract_extension)
-```
-
-Here we extract the extension of the filename and store it in the `extension` field.
-
+<DocumentationButton href="https://cocoindex.io/docs/custom_ops/custom_functions" text="Custom Function" margin="0 0 16px 0" />
 
 ### Split the file into chunks
-
-We will chunk the code with Tree-sitter. 
-We use the `SplitRecursively` function to split the file into chunks. 
-It is integrated with Tree-sitter, so you can pass in the language to the `language` parameter.
-To see all supported language names and extensions, see the documentation [here](https://cocoindex.io/docs/ops/functions#splitrecursively). All the major languages are supported, e.g., Python, Rust, JavaScript, TypeScript, Java, C++, etc. If it's unspecified or the specified language is not supported, it will be treated as plain text.
+We use the `SplitRecursively` function to split the file into chunks.  `SplitRecursively` is CocoIndex building block, with native integration with Tree-sitter. You need to pass in the language to the `language` parameter if you are processing code.
 
 ```python
 with data_scope["files"].row() as file:
+    # Extract the extension of the filename.
+    file["extension"] = file["filename"].transform(extract_extension)
     file["chunks"] = file["content"].transform(
           cocoindex.functions.SplitRecursively(),
           language=file["extension"], chunk_size=1000, chunk_overlap=300) 
 ```
+<DocumentationButton href="https://cocoindex.io/docs/ops/functions#splitrecursively" text="SplitRecursively" margin="0 0 16px 0" />
 
+![SplitRecursively](/img/examples/codebase_index/chunk.png)
 
 ### Embed the chunks
-
 We use `SentenceTransformerEmbed` to embed the chunks. 
-You can refer to the documentation [here](https://cocoindex.io/docs/ops/functions#sentencetransformerembed). 
 
 ```python
 @cocoindex.transform_flow()
 def code_to_embedding(text: cocoindex.DataSlice[str]) -> cocoindex.DataSlice[list[float]]:
-    """
-    Embed the text using a SentenceTransformer model.
-    """
     return text.transform(
         cocoindex.functions.SentenceTransformerEmbed(
             model="sentence-transformers/all-MiniLM-L6-v2"))
 ```
 
-Then for each chunk, we will embed it using the `code_to_embedding` function. and collect the embeddings to the `code_embeddings` collector.
+<DocumentationButton href="https://cocoindex.io/docs/ops/functions#sentencetransformerembed" text="SentenceTransformerEmbed" margin="0 0 16px 0" />
+
+:::tip
+`@cocoindex.transform_flow()` is needed to share the transformation across indexing and query. When building a vector index and querying against it, the embedding computation must remain consistent between indexing and querying.
+:::
 
-`@cocoindex.transform_flow()` is needed to share the transformation across indexing and query. We build a vector index and query against it, 
-the embedding computation needs to be consistent between indexing and querying. See [documentation](https://cocoindex.io/docs/query#transform-flow) for more details.
+<DocumentationButton href="https://cocoindex.io/docs/query#transform-flow" text="Transform Flow" margin="0 0 16px 0" />
 
+Then for each chunk, we will embed it using the `code_to_embedding` function, and collect the embeddings to the `code_embeddings` collector.
 
 ```python
 with data_scope["files"].row() as file:
@@ -113,10 +130,7 @@ with data_scope["files"].row() as file:
                                 code=chunk["text"], embedding=chunk["embedding"])
 ```
 
-
-### 2.4 Collect the embeddings
-
-Export the embeddings to a table.
+### Export the embeddings
 
 ```python
 code_embeddings.export(
@@ -126,8 +140,7 @@ code_embeddings.export(
     vector_indexes=[cocoindex.VectorIndex("embedding", cocoindex.VectorSimilarityMetric.COSINE_SIMILARITY)])
 ```
 
-We use Consine Similarity to measure the similarity between the query and the indexed data. 
-To learn more about Consine Similarity, see [Wiki](https://en.wikipedia.org/wiki/Cosine_similarity).
+We use [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to measure the similarity between the query and the indexed data. 
 
 ## Query the index
 We match against user-provided text by a SQL query, reusing the embedding operation in the indexing flow.
@@ -180,13 +193,16 @@ if __name__ == "__main__":
 
 ## Run the index setup & update
 
-🎉 Now you are all set!
+- Install dependencies
+    ```bash
+    pip install -e .
+    ```
 
-Run following command to setup and update the index.
-```sh
-cocoindex update --setup main.py
-```
-You'll see the index updates state in the terminal
+- Setup and update the index
+    ```sh
+    cocoindex update --setup main.py
+    ```
+    You'll see the index updates state in the terminal
 
 
 ## Test the query
@@ -197,7 +213,13 @@ python main.py
 ```
 
 When you see the prompt, you can enter your search query. for example: spec.
+The returned results - each entry contains score (Cosine Similarity), filename, and the code snippet that get matched.
 
-You can find the search results in the terminal
+## CocoInsight
+To get a better understanding of the indexing flow, you can use CocoInsight to help the development step by step.
+To spin up, it is super easy.
 
-The returned results - each entry contains score (Cosine Similarity), filename, and the code snippet that get matched.
+```
+cocoindex server main.py -ci
+```
+Follow the url from the terminal - `https://cocoindex.io/cocoinsight` to access the CocoInsight.

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/custom_targets.md

@@ -5,23 +5,17 @@ sidebar_class_name: hidden
 slug: /examples/custom_targets
 canonicalUrl: '/examples/custom_targets'
 sidebar_custom_props:
-  image: /img/examples/custom_targets.png
+  image: /img/examples/custom_targets/cover.png
   tags: [custom-building-blocks]
 tags: [custom-building-blocks]
 ---
-import { GitHubButton, YouTubeButton } from '../../../src/components/GitHubButton';
+import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
 
 <GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/custom_output_files"/>
 
 ## Overview
 
-Let’s walk through a simple example—exporting `.md` files as `.html` using a custom file-based target. This project monitors folder changes and continuously converts markdown to HTML incrementally.
-Check out the full [source code](https://github.com/cocoindex-io/cocoindex/tree/main/examples/custom_output_files).
-
-The overall flow is simple:
-This example focuses on 
-- how to configure your custom target
-- the flow effortless picks up the changes in the source, recomputes only what's changed and export to the target
+Let’s walk through a simple example—exporting `.md` files as `.html` using a custom file-based target. This project monitors folder changes and continuously converts markdown to HTML incrementally. The overall flow is simple and primarily focuses on how to configure your custom target.
 
 
 ## Ingest files
@@ -33,16 +27,13 @@ Ingest a list of markdown files:
 def custom_output_files(
 flow_builder: cocoindex.FlowBuilder, data_scope: cocoindex.DataScope
 ) -> None:
-	"""
-	Define an example flow that exports markdown files to HTML files.
-	"""
 	data_scope["documents"] = flow_builder.add_source(
 		cocoindex.sources.LocalFile(path="data", included_patterns=["*.md"]),
 		refresh_interval=timedelta(seconds=5),
 	)
 ```
 This ingestion creates a table with `filename` and `content` fields. 
-
+<DocumentationButton href="https://cocoindex.io/docs/ops/sources" text="Sources" />
 
 ## Process each file and collect
 
@@ -50,11 +41,12 @@ Define custom function that converts markdown to HTML
 
 ```python
 @cocoindex.op.function()
-
 def markdown_to_html(text: str) -> str:
     return _markdown_it.render(text)
 ```
 
+<DocumentationButton href="https://cocoindex.io/docs/custom_ops/custom_functions" text="Custom Function" margin="0 0 16px 0" />
+
 Define data collector and transform each document to html.
 
 ```python
@@ -63,12 +55,15 @@ with data_scope["documents"].row() as doc:
     doc["html"] = doc["content"].transform(markdown_to_html)
     output_html.collect(filename=doc["filename"], html=doc["html"])
 ```
+![Convert markdown to html](/img/examples/custom_targets/convert.png)
 
 
 ##  Define the custom target
 
 ### Define the target spec
 
+<DocumentationButton href="https://cocoindex.io/docs/custom_ops/custom_targets#target-spec" text="Target Spec" margin="0 0 16px 0" />
+
 The target spec contains a directory for output files:
 
 ```python
@@ -76,8 +71,11 @@ class LocalFileTarget(cocoindex.op.TargetSpec):
     directory: str
 ```
 
+
 ### Implement the connector
 
+<DocumentationButton href="https://cocoindex.io/docs/custom_ops/custom_targets#target-connector" text="Target Connector" margin="0 0 16px 0" />
+
 `get_persistent_key()` defines the persistent key,
 which uniquely identifies the target for change tracking and incremental updates. Here, we simply use the target directory as the key (e.g., `./data/output`).
 
@@ -180,17 +178,15 @@ def mutate(
 ### Use it in the Flow
 
 ```python
-    output_html.export(
-        "OutputHtml",
-        LocalFileTarget(directory="output_html"),
-        primary_key_fields=["filename"],
-    )
+output_html.export(
+    "OutputHtml",
+    LocalFileTarget(directory="output_html"),
+    primary_key_fields=["filename"],
+)
 ```
 
 ## Run the example
 
-Once your pipeline is set up, keeping your knowledge graph updated is simple:
-
 ```bash
 pip install -e .
 cocoindex update --setup main.py

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/docs_to_knowledge_graph.md

@@ -5,35 +5,45 @@ sidebar_class_name: hidden
 slug: /examples/knowledge-graph-for-docs
 canonicalUrl: '/examples/knowledge-graph-for-docs'
 sidebar_custom_props:
-  image: /img/examples/docs_to_knowledge_graph.png
+  image: /img/examples/docs_to_knowledge_graph/cover.png
   tags: [knowledge-graph, structured-data-extraction]
 tags: [knowledge-graph, structured-data-extraction]
 ---
 
-import { GitHubButton, YouTubeButton } from '../../../src/components/GitHubButton';
+import { GitHubButton, YouTubeButton, DocumentationButton } from '../../../src/components/GitHubButton';
 
 <GitHubButton url="https://github.com/cocoindex-io/cocoindex/tree/main/examples/docs_to_knowledge_graph"/>
 <YouTubeButton url="https://youtu.be/2KVkpUGRtnk?si=MRalDweWrid-IFje" />
 
-
 ## Overview
-We will generate two kinds of relationships:
-
+[CocoIndex](https://github.com/cocoindex-io/cocoindex) makes it easy to build and maintain knowledge graphs with continuous source updates. In this tutorial, we will use LLM to extract relationships between the concepts in each document, and generate two kinds of relationships:
 1. Relationships between subjects and objects. E.g., "CocoIndex supports Incremental Processing"
 2. Mentions of entities in a document. E.g., "core/basics.mdx" mentions `CocoIndex` and `Incremental Processing`.
 
+and then build a knowledge graph.
+
+![Relationship between subjects and objects](/img/examples/docs_to_knowledge_graph/relationship.png)
+
+
+## Flow Overview
+![Flow overview](/img/examples/docs_to_knowledge_graph/flow.png)
+- Add documents as source.
+- For each document, extract the title and summary, and collects to `Document` nodes.
+- For each document, use LLM to extract relationships — `subject`, `predicate`, `object`, and collect different kinds of relationships.
+- CocoIndex can direct map the collected data to Neo4j nodes and relationships.
+
 ## Setup
 *   [Install PostgreSQL](https://cocoindex.io/docs/getting_started/installation#-install-postgres). CocoIndex uses PostgreSQL internally for incremental processing. 
-*   [Install Neo4j](https://cocoindex.io/docs/ops/storages#Neo4j), a graph database.
-*   [Configure your OpenAI API key](https://cocoindex.io/docs/ai/llm#openai). Alternatively, you can switch to Ollama, which runs LLM models locally - [guide](https://cocoindex.io/docs/ai/llm#ollama).
+*   [Install Neo4j](https://cocoindex.io/docs/ops/targets#neo4j-dev-instance), a graph database.
+*   [Configure your OpenAI API key](https://cocoindex.io/docs/ai/llm#openai). Alternatively, you can switch to Ollama, which runs LLM models locally.
+    <DocumentationButton href="https://cocoindex.io/docs/ai/llm#ollama" text="Ollama" margin="0 0 16px 0" />
 
 ## Documentation
-You can read the official CocoIndex Documentation for Property Graph Targets [here](https://cocoindex.io/docs/ops/storages#property-graph-targets).
+<DocumentationButton href="https://cocoindex.io/docs/ops/targets#property-graph-targets" text="Property Graph Targets" margin="0 0 16px 0" />
 
 
 ## Data flow to build knowledge graph
 
-
 ### Add documents as source
 
 We will process CocoIndex documentation markdown files (`.md`, `.mdx`) from the `docs/core` directory ([markdown files](https://github.com/cocoindex-io/cocoindex/tree/main/docs/docs/core), [deployed docs](https://cocoindex.io/docs/core/basics)). 
@@ -49,6 +59,8 @@ def docs_to_kg_flow(flow_builder: cocoindex.FlowBuilder, data_scope: cocoindex.D
 Here `flow_builder.add_source` creates a [KTable](https://cocoindex.io/docs/core/data_types#KTable).
 `filename` is the key of the KTable.
 
+<DocumentationButton href="https://cocoindex.io/docs/ops/sources" text="Sources" margin="0 0 16px 0" />
+
 
 ### Add data collectors
 
@@ -92,7 +104,7 @@ with data_scope["documents"].row() as doc:
 
 `doc["summary"]` adds a new column to the KTable `data_scope["documents"]`.
 
-
+![Document summary](/img/examples/docs_to_knowledge_graph/summary.png)
 
 ### Extract relationships from the document using LLM
 
@@ -138,6 +150,7 @@ doc["relationships"] = doc["content"].transform(
 
 `doc["relationships"]` adds a new field `relationships` to each document. `output_type=list[Relationship]` specifies that the output of the transformation is a [LTable](https://cocoindex.io/docs/core/data_types#LTable).
 
+![Extract Relationships](/img/examples/docs_to_knowledge_graph/extract_relationship.png)
 
 ### Collect relationships
 
@@ -160,7 +173,6 @@ with doc["relationships"].row() as relationship:
         id=cocoindex.GeneratedField.UUID, entity=relationship["object"],
         filename=doc["filename"],
     )
-
 ```
 
 - `entity_relationship` collects relationships between subjects and objects.
@@ -178,6 +190,7 @@ All nodes for Neo4j need two things:
 
 CocoIndex uses the primary key field to match the nodes and deduplicate them. If you have multiple nodes with the same primary key, CocoIndex keeps only one of them.
 
+![Deduplication](/img/examples/docs_to_knowledge_graph/dedupe.png)
 
 There are two ways to map nodes:
 1. When you have a collector just for the node, you can directly export it to Neo4j.
@@ -198,6 +211,7 @@ conn_spec = cocoindex.add_auth_entry(
 
 #### Export `Document` nodes to Neo4j
 
+![Document nodes](/img/examples/docs_to_knowledge_graph/export_document.png)
 
 ```python
 document_node.export(
@@ -214,6 +228,7 @@ This exports Neo4j nodes with label `Document` from the `document_node` collecto
 - It carries all the fields from `document_node` collector to Neo4j nodes with label `Document`.
 
 
+
 #### Export `RELATIONSHIP` and `Entity` nodes to Neo4j
 
 We don't have explicit collector for `Entity` nodes. 
@@ -233,6 +248,8 @@ flow_builder.declare(
 
 Next, export the `entity_relationship` to Neo4j.
 
+![Export relationship](/img/examples/docs_to_knowledge_graph/export_relationship.png)
+
 ```python
 entity_relationship.export(
     "entity_relationship",
@@ -258,7 +275,6 @@ entity_relationship.export(
     ),
     primary_key_fields=["id"],
 )
-)
 ```
 
 The `cocoindex.storages.Relationships` declares how to map relationships in Neo4j.
@@ -272,6 +288,7 @@ Note that different relationships may share the same source and target nodes.
 
 #### Export the `entity_mention` to Neo4j.
 
+![Export Entity Mention](/img/examples/docs_to_knowledge_graph/relationship.png)
 
 ```python
 entity_mention.export(
@@ -302,8 +319,6 @@ It creates relationships by:
 
 
 ## Query and test your index
-🎉 Now you are all set!
-
 1.  Install the dependencies:
 
     ```sh
@@ -315,23 +330,24 @@ It creates relationships by:
     cocoindex update --setup main.py
     ```
     
-    You'll see the index updates state in the terminal. For example, you'll see the following output:
+    You'll see the index updates state in the terminal. For example,
 
     ```
     documents: 7 added, 0 removed, 0 updated
     ```
 
-3.  (Optional) I used CocoInsight to troubleshoot the index generation and understand the data lineage of the pipeline. 
-It is in free beta now, you can give it a try. Run following command to start CocoInsight:
+## CocoInsight
 
-    ```sh
-    cocoindex server -ci main.py
-    ```
+I used CocoInsight to troubleshoot the index generation and understand the data lineage of the pipeline.  It is in free beta now, you can give it a try. 
 
-    And then open the url https://cocoindex.io/cocoinsight.  It just connects to your local CocoIndex server, with Zero pipeline data retention.
+```sh
+cocoindex server -ci main.py
+```
 
+And then open the url `https://cocoindex.io/cocoinsight`.  It just connects to your local CocoIndex server, with zero pipeline data retention.
 
-### Browse the knowledge graph
+
+## Browse the knowledge graph
 After the knowledge graph is built, you can explore the knowledge graph you built in Neo4j Browser.
 
 For the dev environment, you can connect to Neo4j browser using credentials:
@@ -345,11 +361,29 @@ You can open it at [http://localhost:7474](http://localhost:7474), and run the f
 MATCH p=()-->() RETURN p
 ```
 
+## Kuzu
+Cocoindex natively supports Kuzu - a high performant, embedded open source graph database.
+
+<DocumentationButton href="https://cocoindex.io/docs/ops/targets#kuzu" text="Kuzu" margin="0 0 16px 0" /> 
 
+The GraphDB interface in CocoIndex is standardized, you just need to **switch the configuration** without any additional code changes. CocoIndex supports exporting to Kuzu through its API server. You can bring up a Kuzu API server locally by running:
 
-## Support us
-We are constantly improving, and more features and examples are coming soon. 
-If you love this article, please give us a star ⭐ at [GitHub repo](https://github.com/cocoindex-io/cocoindex) to help us grow.
+``` sh
+KUZU_DB_DIR=$HOME/.kuzudb
+KUZU_PORT=8123
+docker run -d --name kuzu -p ${KUZU_PORT}:8000 -v ${KUZU_DB_DIR}:/database kuzudb/api-server:latest
+```
+
+In your CocoIndex flow, you need to add the Kuzu connection spec to your flow.
+
+```python
+kuzu_conn_spec = cocoindex.add_auth_entry(
+    "KuzuConnection",
+    cocoindex.storages.KuzuConnection(
+        api_server_url="http://localhost:8123",
+    ),
+)
+```
 
-Thanks for reading!
+<GitHubButton url="https://github.com/cocoindex-io/cocoindex/blob/30761f8ab674903d742c8ab2e18d4c588df6d46f/examples/docs_to_knowledge_graph/main.py#L33-L37"  margin="0 0 16px 0" />
 

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/image_search.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/image_search
 canonicalUrl: '/examples/image_search'
 sidebar_custom_props:
-  image: /img/examples/image_search.png
+  image: /img/examples/image_search/cover.png
   tags: [vector-index, multi-modal]
 tags: [vector-index, multi-modal]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/manual_extraction.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/manual_extraction
 canonicalUrl: '/examples/manual_extraction'
 sidebar_custom_props:
-  image: /img/examples/manual_extraction.png
+  image: /img/examples/manual_extraction/cover.png
   tags: [structured-data-extraction, data-mapping]
 tags: [structured-data-extraction, data-mapping]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/multi_format_index.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/multi_format_index
 canonicalUrl: '/examples/multi_format_index'
 sidebar_custom_props:
-  image: /img/examples/multi_format_index.png
+  image: /img/examples/multi_format_index/cover.png
   tags: [vector-index, multi-modal]
 tags: [vector-index, multi-modal]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/patient_form_extraction.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/patient_form_extraction
 canonicalUrl: '/examples/patient_form_extraction'
 sidebar_custom_props:
-  image: /img/examples/patient_form_extraction.png
+  image: /img/examples/patient_form_extraction/cover.png
   tags: [structured-data-extraction, data-mapping ]
 tags: [structured-data-extraction, data-mapping]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/photo_search.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/photo_search
 canonicalUrl: '/examples/photo_search'
 sidebar_custom_props:
-  image: /img/examples/photo_search.png
+  image: /img/examples/photo_search/cover.png
   tags: [vector-index, multi-modal]
 tags: [vector-index, multi-modal]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/product_recommendation.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/product_recommendation
 canonicalUrl: '/examples/product_recommendation'
 sidebar_custom_props:
-  image: /img/examples/product_recommendation.png
+  image: /img/examples/product_recommendation/cover.png
   tags: [knowledge-graph ]
 tags: [knowledge-graph]
 ---

{cocoindex-0.1.82 → cocoindex-0.1.83}/docs/docs/examples/examples/simple_vector_index.md

@@ -5,7 +5,7 @@ sidebar_class_name: hidden
 slug: /examples/simple_vector_index
 canonicalUrl: '/examples/simple_vector_index'
 sidebar_custom_props:
-  image: /img/examples/simple_vector_index.png
+  image: /img/examples/simple_vector_index/cover.png
   tags: [vector-index]
 tags: [vector-index]
 ---