API Reference

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 auth: Authentication context

Returns: Graph: The updated graph object

POST

graph

{name}

update

curl --request POST \
  --url http://localhost:8000/graph/{name}/update \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_filters": {},
  "additional_documents": [
    "<string>"
  ],
  "prompt_overrides": {
    "entity_extraction": {
      "prompt_template": "<string>",
      "examples": [
        {
          "label": "<string>",
          "type": "<string>",
          "properties": {}
        }
      ]
    },
    "entity_resolution": {
      "prompt_template": "<string>",
      "examples": [
        {
          "canonical": "<string>",
          "variants": [
            "<string>"
          ]
        }
      ]
    }
  }
}'

{
  "id": "<string>",
  "name": "<string>",
  "entities": [
    {
      "id": "<string>",
      "label": "<string>",
      "type": "<string>",
      "properties": {},
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "relationships": [
    {
      "id": "<string>",
      "source_id": "<string>",
      "target_id": "<string>",
      "type": "<string>",
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "metadata": {},
  "document_ids": [
    "<string>"
  ],
  "filters": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "owner": {},
  "access_control": {}
}

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

prompt_overrides.entity_extraction

object | null

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

prompt_overrides.entity_resolution

object | null

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

Response

200

application/json

Successful Response

Represents a knowledge graph

name

string

required

string

entities

object[]

Represents an entity in a knowledge graph

relationships

object[]

Represents a relationship between entities in a knowledge graph

metadata

object

document_ids

string[]

filters

object | null

created_at

string

updated_at

string

owner

object

access_control

object

Was this page helpful?

Suggest edits Raise issue

List Graphs Generate Local Uri

curl --request POST \
  --url http://localhost:8000/graph/{name}/update \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_filters": {},
  "additional_documents": [
    "<string>"
  ],
  "prompt_overrides": {
    "entity_extraction": {
      "prompt_template": "<string>",
      "examples": [
        {
          "label": "<string>",
          "type": "<string>",
          "properties": {}
        }
      ]
    },
    "entity_resolution": {
      "prompt_template": "<string>",
      "examples": [
        {
          "canonical": "<string>",
          "variants": [
            "<string>"
          ]
        }
      ]
    }
  }
}'

{
  "id": "<string>",
  "name": "<string>",
  "entities": [
    {
      "id": "<string>",
      "label": "<string>",
      "type": "<string>",
      "properties": {},
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "relationships": [
    {
      "id": "<string>",
      "source_id": "<string>",
      "target_id": "<string>",
      "type": "<string>",
      "document_ids": [
        "<string>"
      ],
      "chunk_sources": {}
    }
  ],
  "metadata": {},
  "document_ids": [
    "<string>"
  ],
  "filters": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "owner": {},
  "access_control": {}
}