Update Graph

Update an existing graph with new documents.

This endpoint processes additional documents based on the original graph filters and/or new filters/document IDs, extracts entities and relationships, and updates the graph with new information.

Args: name: Name of the graph to update request: UpdateGraphRequest containing:

• additional_filters: Optional additional metadata filters to determine which new documents to include
• additional_documents: Optional list of additional document IDs to include
• prompt_overrides: Optional customizations for entity extraction and resolution prompts
• folder_name: Optional folder to scope the operation to
• end_user_id: Optional end-user ID to scope the operation to auth: Authentication context

Returns: Graph: The updated graph object

Headers

authorization

string

Path Parameters

name

string

required

Body

application/json

Request model for updating a graph

additional_filters

object | null

Optional additional metadata filters to determine which new documents to include

additional_documents

string[] | null

Optional list of additional document IDs to include

prompt_overrides

object | null

Optional customizations for entity extraction and resolution prompts

Show child attributes

prompt_overrides.entity_extraction

object | null

Overrides for entity extraction prompts - controls how entities are identified in text during graph operations

Show child attributes

prompt_overrides.entity_extraction.prompt_template

string | null

Custom prompt template, MUST include both {content} and {examples} placeholders. The {content} placeholder will be replaced with the text to analyze, and {examples} will be replaced with formatted examples.

prompt_overrides.entity_extraction.examples

object[] | null

Examples of entities to extract, used to guide the LLM toward domain-specific entity types and patterns.

Example entity for guiding entity extraction.

Used to provide domain-specific examples to the LLM of what entities to extract. These examples help steer the extraction process toward entities relevant to your domain.

Show child attributes

prompt_overrides.entity_extraction.examples.label

string

required

The entity label (e.g., 'John Doe', 'Apple Inc.')

prompt_overrides.entity_extraction.examples.type

string

required

The entity type (e.g., 'PERSON', 'ORGANIZATION', 'PRODUCT')

prompt_overrides.entity_extraction.examples.properties

object | null

Optional properties of the entity (e.g., {'role': 'CEO', 'age': 42})

prompt_overrides.entity_resolution

object | null

Overrides for entity resolution prompts - controls how variant forms are grouped during graph operations

Show child attributes

prompt_overrides.entity_resolution.prompt_template

string | null

Custom prompt template that MUST include both {entities_str} and {examples_json} placeholders. The {entities_str} placeholder will be replaced with the extracted entities, and {examples_json} will be replaced with JSON-formatted examples of entity resolution groups.

prompt_overrides.entity_resolution.examples

object[] | null

Examples of entity resolution groups showing how variants of the same entity should be resolved to their canonical forms. This is particularly useful for domain-specific terminology, abbreviations, and naming conventions.

Example for entity resolution, showing how variants should be grouped.

Entity resolution is the process of identifying when different references (variants) in text refer to the same real-world entity. These examples help the LLM understand domain-specific patterns for resolving entities.

Show child attributes

prompt_overrides.entity_resolution.examples.canonical

string

required

The canonical (standard/preferred) form of the entity

prompt_overrides.entity_resolution.examples.variants

string[]

required

List of variant forms that should resolve to the canonical form

folder_name

string | null

Optional folder scope for the operation

end_user_id

string | null

Optional end-user scope for the operation

Response

200

application/json

Successful Response

Represents a knowledge graph

name

string

required

id

string

entities

object[]

Represents an entity in a knowledge graph

Show child attributes

entities.label

string

required

entities.type

string

required

entities.id

string

entities.properties

object

entities.document_ids

string[]

entities.chunk_sources

object

Show child attributes

entities.chunk_sources.{key}

integer[]

relationships

object[]

Represents a relationship between entities in a knowledge graph

Show child attributes

relationships.source_id

string

required

relationships.target_id

string

required

relationships.type

string

required

relationships.id

string

relationships.document_ids

string[]

relationships.chunk_sources

object

Show child attributes

relationships.chunk_sources.{key}

integer[]

metadata

object

system_metadata

object

document_ids

string[]

filters

object | null

created_at

string

updated_at

string

owner

object

Show child attributes

owner.{key}

string

access_control

object

Show child attributes

access_control.{key}

string[]