Skip to content

Instantly share code, notes, and snippets.

@akshat-khare
Created June 29, 2023 06:06
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save akshat-khare/a616c59ae4b544556d089ff5d49365f8 to your computer and use it in GitHub Desktop.
Save akshat-khare/a616c59ae4b544556d089ff5d49365f8 to your computer and use it in GitHub Desktop.

Optisearch User Guide

Welcome to Optisearch, a powerful AI-powered tool that lets you query your files in natural language. Optisearch supports a wide range of file types including text, PDF, HTML, and others.

Prepare Your Board

Before using Optisearch, make sure to set up your monday.com board as follows:

  1. Create a 'Files' Column: Create a new column of the 'Files' type on your board.

  2. Upload Your Files: Upload the files you want to analyze into this new column. Each file should be placed in the respective item row. For sample text and PDF files, refer to this Google Drive folder.

Run Optisearch

With your board set up and files uploaded, you can now run Optisearch to perform your analyses.

  1. Select Your Group and Index Your Files: In the Optisearch application, select the group that contains the items you want to analyze. Then click on 'Index'. This will index your files, preparing them for analysis.

  2. Choose a Strategy: Optisearch offers two different strategies for analysis:

    • Cohere Retrieval QA: This option selects the most relevant chunk from your files and uses OpenAI to answer your questions. It's faster but might not always capture the full context.
    • Anthropic QA: This option uses the entire document to answer the question, providing answers that consider the whole document's context. This approach has a very high context length, but it may take longer.
  3. Ask Your Question: Enter your question in natural language, like "What problem is the team facing while painting the building?".

  4. Wait for Results: Optisearch will process your query and provide an answer based on your selected strategy. Please note that the processing time may vary depending on the complexity and size of your files.

After you've completed your work, you can choose to 'Reset Index'. This will clear the current index and allow you to restart the system from scratch.


Please note that these instructions are a general guide. Your use of Optisearch may differ slightly depending on your specific board setup and requirements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment