Integrate Perplexica search as a plugin

[boliang-pinai]

Relates to

Improving agent's web search and real time information retrieval capability by integrating the open-sourced Perplexica search.

Risks

Low

Background

What does this PR do?

This PR provides an alternative open-source LLM based web search plugin in addition to the current one.

What kind of change is this?

It adds plugin-preplexica which includes Perplexica search as a Service.

Usage

An example of using the plugin for Telegram client:

1. First, set up Perplexica search engine by following the instructions at Perplexica Installation Guide

2. Configure the Perplexica search engine in your .env file:

# Perplexica Configuration
PERPLEXICA_API_URL=                         # Default: http://localhost:3001/api/search
PERPLEXICA_MODEL_PROVIDER=                  # Default: openai
PERPLEXICA_MODEL_NAME=                      # Default: gpt-4o-mini
PERPLEXICA_EMBEDDING_MODEL_PROVIDER=        # Default: openai
PERPLEXICA_EMBEDDING_MODEL_NAME=            # Default: text-embedding-3-large

3. Edit the character file to enable the Perplexica search plugin:

...

"plugins": ["@elizaos/plugin-perplexica"]

...

4. Modify the client to use the Perplexica search service. For example, in the Telegram client, modify the messageManager.ts file to use the Perplexica search service:

import { IPerplexicaSearchService } from "@elizaos/plugin-perplexica";

export class MessageManager {
    // Main handler for incoming messages
    public async handleMessage(ctx: Context): Promise<void> {
        ...

        // Create additional state keys
        let stateAdditionalKeys: { [key: string]: string } = {};

        // Get perplexity search result
        const searchResult = await this.runtime.getService<IPerplexicaSearchService>(ServiceType.PERPLEXICA_SEARCH).search(
            `${messageText} (says to ${this.runtime.character.name}, please reply in a short paragraph)`
        );
        stateAdditionalKeys["searchResult"] = `# Web Search Results (ignore if irrelevant)\n${searchResult.message}`;

        // Update state with the new memory
        let state = await this.runtime.composeState(memory, stateAdditionalKeys);
        state = await this.runtime.updateRecentMessageState(state);

        ...
    }
}

5. Start the agent as usual.

Documentation changes needed?

Testing

Web search results are added to state and injected to the context:

Telegram bot:

Where should a reviewer start?

Detailed testing steps

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Hi @boliang-pinai! Welcome to the elizaOS community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now an elizaOS contributor!

[graphite-app]

The debug log references this.settings.optimizationMode and this.settings.focusMode, but these properties don't exist in the settings object. The log should use the function parameters optimizationMode and focusMode directly since they contain the actual values being used in the search.

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.