Overview

Welcome to the Search Tweak documentation. This documentation will guide you through the various features and concepts of our platform, helping you to optimize and enhance your search engine performance.

Table of Contents

  • Search Endpoints
    • Understand the concept of search endpoints and how to configure them.
  • Mapper Code
    • Learn how to use mapper code to extract specific data attributes from the search response.
  • Search Models
    • Detailed information on creating and managing search models.
  • Search Evaluations
    • Learn how to set up and perform search evaluations to analyze the performance of your search engine.
  • Evaluation Metrics
    • Explore the various metrics used to evaluate and optimize search models.
  • Team Management
    • Explore the team management features of Search Tweak.
  • Tags
    • Understand how tags can be used to organize and manage search evaluations and evaluators.
  • API Reference
    • Detailed information on the Search Tweak API.

Getting Started

To get started with Search Tweak, we recommend exploring the following sections:

Search Endpoints

Discover how to create and manage search endpoints, including setting up URLs, methods, mapper code, and custom headers.

Mapper Code

Understand the syntax and usage of mapper code to accurately extract data from multi-dimensional arrays.

Search Models

Learn how to configure Search Models to define how search requests are processed and evaluated.

Search Evaluations

Find out how to evaluate your search models, interpret the results, and make data-driven improvements.

Evaluation Metrics

Explore the various metrics used to evaluate and optimize search models, including precision, cumulative gain, normalized discounted cumulative gain, and more.

Team Management

Explore the team management features of Search Tweak, including roles, permissions, and user management.

Tags

Discover how tags in Search Tweak streamline the organization and assignment of evaluators to specific search evaluations and models.

API Reference

Explore the Search Tweak API documentation to integrate our platform with your existing systems and workflows.


This documentation is designed to be your comprehensive guide to all the features and functionalities of Search Tweak. If you have any questions or need further assistance, please do not hesitate to contact our support team.