Zep v3 icon

Zep v3

Interact with Zep Cloud v3 API

Overview

The "Get User Context" operation of the Thread resource in this node allows you to retrieve contextual information related to a specific thread. This context is typically a summary or detailed facts relevant to the thread's conversation or content, filtered optionally by a minimum relevance rating. It is useful for scenarios where you want to understand the background or important details associated with a thread, such as summarizing chat history, extracting key facts, or providing context-aware responses.

Practical examples include:

  • Fetching a concise summary of a customer support chat thread to quickly understand the issue.
  • Retrieving relevant facts from a discussion thread to assist an AI assistant in generating informed replies.
  • Filtering context by relevance rating to focus on the most important information within a thread.

Properties

Name Meaning
Thread ID The unique identifier of the thread from which to get user context (required).
Min Rating Optional filter to only include facts with a rating equal or above this value (0 to 1).
Mode The mode of context retrieval: "Summary" (default) provides summarized context; "Basic" offers faster, less detailed context.

Output

The output JSON contains the user context data retrieved from the specified thread. This typically includes summarized or detailed contextual information relevant to the thread, depending on the selected mode and filters.

The exact structure depends on the API response but generally includes fields representing the context blocks or facts associated with the thread.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Zep Cloud v3 API.
  • The node makes HTTP requests to https://api.getzep.com endpoints.
  • Proper configuration of the API authentication credential in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Thread ID will cause the API request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing an invalid Min Rating (outside 0-1 range) may cause unexpected filtering behavior.
    • Selecting an unsupported mode value will cause an error.
  • Error messages:

    • "Unknown thread operation: getUserContext": Indicates the operation name was not recognized; ensure the correct operation is selected.
    • HTTP 401 Unauthorized: Check that the API key credential is correctly configured and valid.
    • HTTP 404 Not Found: Verify that the Thread ID exists and is accessible.
    • Validation errors related to parameters: Ensure all required parameters are provided and valid.

Links and References

Discussion