Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Overview

The node interacts with the Zep Cloud v3 API to manage knowledge graphs and their components. Specifically, for the Graph resource and the Set Entity Types operation, it allows users to define or update the entity types and edge types within a graph. This is useful for customizing the schema of a knowledge graph by specifying what kinds of entities (nodes) and relationships (edges) are recognized.

Typical use cases include:

  • Defining custom entity types and edge types to tailor the graph structure to specific domain needs.
  • Updating existing entity and edge type definitions to reflect changes in data modeling.
  • Preparing a graph schema before adding data to ensure consistency and validation.

For example, a user might set entity types like "Person", "Organization", and edge types like "WORKS_FOR" or "KNOWS" to model social networks or organizational structures.

Properties

Name Meaning
Entity Types Array of entity type objects. These define the types of nodes/entities in the graph.
Edge Types Array of edge type objects. These define the types of relationships/edges between entities.

Both properties expect JSON arrays describing the respective types. The exact structure of these objects depends on the API's schema but typically includes fields like name, description, and attributes defining each type.

Output

The output is a JSON object representing the response from the Zep Cloud API after setting the entity and edge types. This usually includes confirmation of the updated types or details about the current schema state.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Zep Cloud API.
  • The node makes HTTP requests to https://api.getzep.com/api/v2/entity-types endpoint using PUT method.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Invalid JSON Input: If the Entity Types or Edge Types JSON is malformed, the API request will fail. Ensure valid JSON format.
  • Missing Authentication: Without a valid API key credential, requests will be unauthorized.
  • Empty Arrays: Providing empty arrays will clear all entity or edge types; verify if this is intended.
  • API Errors: The node throws errors if the API returns failure responses. Check error messages for details such as invalid fields or permission issues.
  • Network Issues: Connectivity problems can cause request failures; verify network access to the API endpoint.

Links and References


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

Discussion