Skip to main content
This will help you get started with the Egnyte retriever. For detailed documentation of all EgnyteRetriever features and configurations head to the API reference.

Overview

The EgnyteRetriever class helps you search and retrieve documents from Egnyte using hybrid search capabilities that combine semantic and keyword search. This retriever is fully compliant with LangChain standards and supports both synchronous and asynchronous operations.

Integration details

Bring-your-own data (i.e., index and search a custom corpus of documents):

Setup

In order to use the Egnyte package, you will need:
  • An Egnyte account — If you are not a current Egnyte customer or want to test outside of your production Egnyte instance, you can use a free developer account.
  • An Egnyte app — This is configured in the developer console, and must have the appropriate scopes enabled.
  • The app must be enabled by the administrator. For free developer accounts, this is whoever signed up for the account.

Credentials

For these examples, we will use Bearer token authentication with an Egnyte user token. To generate a user token:
  1. Register for a developer account at https://developers.egnyte.com/member/register
  2. Generate a user token following the Public API Authentication guide
  3. Important: Use the scope Egnyte.ai when generating the token
If you want to get automated tracing from individual queries, you can also set your LangSmith API key by uncommenting below:

Installation

This retriever lives in the egnyte-langchain-connector package:

Instantiation

Now we can instantiate our retriever:

Usage

Advanced Search with Options

For more granular search, you can use EgnyteSearchOptions to filter results by folder path, date range, and more:

Async usage

The retriever supports asynchronous operations:

Batch operations

You can process multiple queries in batch:

Use as an agent tool

Like other retrievers, EgnyteRetriever can be added to a LangGraph agent as a tool.

API reference

For detailed documentation of all EgnyteRetriever features and configurations, visit the GitHub repository.

Help

If you have questions, check out the Egnyte developer documentation or reach out to the Egnyte developer community.