Skip to content

Using Proposals

Overview

NeuralSeek offers a flexible and dynamic way to manage configurations through the use of "Proposals." This feature allows administrators and Subject Matter Experts (SMEs) to test proposed changes separately from the main configuration, enabling multiple configurations to run concurrently. This guide will walk you through the common issues, steps to configure this feature, and provide answers to frequently asked questions.

Common use cases

  • Running Multiple Configurations: Users often need to run different versions of NeuralSeek simultaneously, especially when making backend changes without affecting existing extensions or integrations.
  • Overriding Default Settings: Users may want to override default settings like "Max Verbosity" for specific API calls without changing the global configuration.
  • Managing Multiple KBs/Projects: Integrating multiple projects from Watson Discovery into a single NeuralSeek instance can be challenging.

How to use Proposals

image image

  • Save Your Configuration as a Proposal:

    • Navigate to the configuration tab in NeuralSeek.
    • Adjust your settings to the desired state.
    • Instead of clicking "Save," click on "Propose Changes."
    • Name the proposal (optional) and save within the popup. This will show "Proposal Saved".
    • Find your Proposal ID (green arrow) within the "Change Logs" menu. An ID number will be shown in the Date column. This will be used to reference the proposal configuration.

  • Managing Configurations/Proposals:

    • For each unique configuration needed, save it as a separate proposal.
    • Reference the appropriate proposal ID when making API calls to apply the desired configuration.
    • Using the Change Log menu, you are able to "Activate" (purple arrow) or "Delete" (red arrow) proposals.
    • Activating a proposal will apply that change to the current/live configuration.

  • Using Proposals in API Calls:

    • When making an API call to NeuralSeek, pass the proposalID as a parameter.
    • This allows you to use the specific configuration associated with the proposal ID without affecting the main configuration.

  • Accessing Proposals from Different Tabs:

    • Proposals can be accessed and called dynamically from the API, the Seek tab, or the Home tabs.

Frequently Asked Questions (FAQs)

  • Q: Can I have two versions of NeuralSeek running at the same time?

    • A: Yes, you can use the proposals feature to run multiple configurations simultaneously.

  • Q: Is it possible to use multiple projects from Watson Discovery in the same NeuralSeek instance?

    • A: Yes, save each project configuration as a different proposal and call them via the API using the respective proposal IDs.

  • Q: Can I override settings like "Max Verbosity" at the API call level?

    • A: Yes, save a configuration with your preferred settings as a proposal and use its ID in the API call to override default settings.

By following this guide, you should be able to effectively utilize NeuralSeek's proposals feature to manage various configurations and enhance your instance's flexibility and efficiency.