> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# mode

> Turns NeuralSearch on or off

export const Setting = ({type, default: defaultValue, defaultNote, scope, min, max, formerly}) => {
  const renderedDefault = defaultValue === '' ? '""' : defaultValue;
  const renderedNote = defaultNote ? `(${defaultNote})` : '';
  return <ul>
      <li><strong>Type:</strong> <code>{type}</code></li>
      <li><strong>Default:</strong> <code>{renderedDefault}</code>{renderedNote}</li>
      {min && <li><strong>Min:</strong> <code>{min}</code></li>}
      {max && <li><strong>Max:</strong> <code>{max}</code></li>}
      <li><strong>Scope:</strong> <a href="/doc/api-reference/api-parameters"><code>{scope}</code></a></li>
      {formerly && <li>
          <strong>Deprecated name:</strong> <code>{formerly}</code>
        </li>}
    </ul>;
};

<Setting type="enum<string>" default="" scope="settings" />

This setting controls whether the engine uses keyword search only or combines it with vector-based semantic search (NeuralSearch).

If [`getRankingInfo`](/doc/api-reference/api-parameters/getRankingInfo) is `true`, the `_rankingInfo` object includes:

* `keywordScore`. Match score from keyword search
* `semanticScore`. Match score from semantic search
* `neuralScore`. Combined score used for final ranking

<Tip>
  This setting only has an effect if you [activated NeuralSearch](/doc/guides/ai-relevance/neuralsearch/get-started).
</Tip>

## Options

<ParamField path="keywordSearch">
  Use only keyword-based search.
</ParamField>

<ParamField path="neuralSearch">
  Use NeuralSearch, which combines keyword and AI-based vector search.
</ParamField>

## Example

<AccordionGroup>
  <Accordion title="Current API clients" defaultOpen="true">
    <CodeGroup>
      ```cs C# theme={"system"}
      var response = await client.SetSettingsAsync(
        "INDEX_NAME",
        new IndexSettings { Mode = Enum.Parse<Mode>("KeywordSearch") }
      );
      ```

      ```dart Dart theme={"system"}
      final response = await client.setSettings(
        indexName: "INDEX_NAME",
        indexSettings: IndexSettings(
          mode: Mode.fromJson("keywordSearch"),
        ),
      );
      ```

      ```go Go theme={"system"}
      response, err := client.SetSettings(client.NewApiSetSettingsRequest(
        "INDEX_NAME",
        search.NewEmptyIndexSettings().SetMode(search.Mode("keywordSearch"))))
      if err != nil {
        // handle the eventual error
        panic(err)
      }
      ```

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setMode(Mode.KEYWORD_SEARCH));
      ```

      ```js JavaScript theme={"system"}
      const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { mode: 'keywordSearch' } });
      ```

      ```kotlin Kotlin theme={"system"}
      var response =
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(mode = Mode.entries.first { it.value == "keywordSearch" }),
        )
      ```

      ```php PHP theme={"system"}
      $response = $client->setSettings(
          'INDEX_NAME',
          ['mode' => 'keywordSearch',
          ],
      );
      ```

      ```python Python theme={"system"}
      response = client.set_settings(
          index_name="INDEX_NAME",
          index_settings={
              "mode": "keywordSearch",
          },
      )
      ```

      ```ruby Ruby theme={"system"}
      response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(mode: "keywordSearch"))
      ```

      ```scala Scala theme={"system"}
      val response = Await.result(
        client.setSettings(
          indexName = "INDEX_NAME",
          indexSettings = IndexSettings(
            mode = Some(Mode.withName("keywordSearch"))
          )
        ),
        Duration(100, "sec")
      )
      ```

      ```swift Swift theme={"system"}
      let response = try await client.setSettings(
          indexName: "INDEX_NAME",
          indexSettings: IndexSettings(mode: SearchMode.keywordSearch)
      )
      ```
    </CodeGroup>
  </Accordion>

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```js JavaScript theme={"system"}
      index.setSettings({ mode: "keywordSearch" });
      ```

      ```php PHP theme={"system"}
      $index->setSettings(['mode' => 'keywordSearch']);
      ```

      ```python Python theme={"system"}
      index.set_settings({mode: "keywordSearch"})
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings({mode: "keywordSearch"})
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>