Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Actions44

Overview

The "Update Graph" operation in the Zep node allows users to modify an existing knowledge graph's metadata and configuration via the Zep Cloud v3 API. This includes updating the graph's name, description, and fact rating instructions that guide how facts within the graph are evaluated for relevance, accuracy, and recency.

This operation is beneficial when you need to maintain or improve the quality and clarity of your knowledge graphs over time. For example, if a graph initially created for customer interaction data needs a clearer description or updated instructions on how to rate facts, this operation enables those updates without recreating the graph.

Practical examples:

  • Renaming a graph from "Customer Data" to "Customer Interaction Knowledge Base".
  • Adding detailed instructions for fact rating to ensure consistent evaluation criteria across team members.
  • Updating the description to reflect new data sources or use cases.

Properties

Name Meaning
Graph ID The unique identifier of the graph to update. This is required to specify which graph will be modified.
Graph Name The new name for the graph. Example: "My Knowledge Graph".
Description A textual description of the graph’s purpose or contents. Example: "A graph containing customer interaction data and knowledge base".
Fact Rating Instruction Configuration for fact rating instructions, including:
- Instruction: Main instruction text guiding fact rating (e.g., "Rate facts based on relevance, accuracy, and recency").
- High Rating Example: Example of a highly rated fact.
- Medium Rating Example: Example of a moderately rated fact.
- Low Rating Example: Example of a low-rated fact.

Output

The output JSON contains the updated graph object as returned by the Zep Cloud API after a successful update operation. This typically includes fields such as the graph's ID, name, description, and any fact rating instructions configured.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "graph_id": "string",
  "name": "string",
  "description": "string",
  "fact_rating_instruction": {
    "instruction": "string",
    "examples": {
      "high": "string",
      "medium": "string",
      "low": "string"
    }
  },
  // ... other metadata fields
}

Dependencies

  • Requires an active connection to the Zep Cloud v3 API.
  • Requires an API key credential configured in n8n for authentication with the Zep API.
  • Network access to https://api.getzep.com must be available.

Troubleshooting

  • Missing Graph ID: The operation requires a valid Graph ID to identify which graph to update. Omitting this or providing an invalid ID will result in an error.
  • Invalid JSON in Fact Rating Instruction: If the fact rating instruction fields contain malformed JSON or unsupported characters, the API may reject the request.
  • API Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Connectivity problems to the Zep API endpoint can cause timeouts or failures.
  • Empty Update Payload: If no properties (name, description, or fact rating instruction) are provided to update, the API might return an error or ignore the request.

To resolve these issues:

  • Verify the Graph ID is correct and exists.
  • Validate all input fields, especially JSON structures.
  • Check API credentials and permissions.
  • Confirm network connectivity.
  • Provide at least one field to update.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion