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

# exactOnSingleWordQuery

> How the Exact ranking criterion is applied to single-word queries

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="attribute" scope="settings,search" formerly="enableExactOnSingleWordQuery, useQueryEqualsOneAttributeInRanking" />

The `exactOnSingleWordQuery` parameter controls how the [Exact ranking criterion](/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria#exact) is evaluated when the query contains only one word.

## Options

<ParamField path="attribute">
  The Exact criterion is applied when the query exactly matches the entire value of an attribute.
</ParamField>

<ParamField path="none">
  The Exact ranking criterion is ignored on single-word queries.
</ParamField>

<ParamField path="word">
  The Exact criterion is applied when the query word is found exactly in the record.
  The word must be at least three characters long and must not be a stop word.
  Only exact matches will be highlighted. Partial or prefix matches will not be.

  <Info>
    By default, Algolia matches query terms at the **beginning of words** in your records (prefix matching). For alternatives, see [Match queries in the middle or end of words](/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/how-to/how-can-i-make-queries-within-the-middle-of-a-word).
  </Info>
</ParamField>

## Example

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

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

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

      ```java Java theme={"system"}
      UpdatedAtResponse response = client.setSettings(
        "INDEX_NAME",
        new IndexSettings().setExactOnSingleWordQuery(ExactOnSingleWordQuery.ATTRIBUTE)
      );
      ```

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

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

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

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

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

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

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

  <Accordion title="Legacy API clients">
    <CodeGroup>
      ```cs C# theme={"system"}
      IndexSettings settings = new IndexSettings();
      settings.ExactOnSingleWordQuery = "attribute"};
      // settings.ExactOnSingleWordQuery = "none";
      // settings.ExactOnSingleWordQuery = "word";

      index.SetSettings(settings);
      ```

      ```go Go theme={"system"}
      res, err := index.SetSettings(search.Settings{
      	ExactOnSingleWordQuery: opt.ExactOnSingleWordQuery(
      		"attribute",
      		// "none",
      		// "word",
      	),
      })
      ```

      ```java Java theme={"system"}
      index.setSettings(
        new IndexSettings().setExactOnSingleWordQuery("attribute")
        // new IndexSettings().setExactOnSingleWordQuery("none")
        // new IndexSettings().setExactOnSingleWordQuery("word")
      );
      ```

      ```js JavaScript theme={"system"}
      index
        .setSettings({
          exactOnSingleWordQuery: "attribute",
          // exactOnSingleWordQuery: 'none'
          // exactOnSingleWordQuery: 'word'
        })
        .then(() => {
          // done
        });
      ```

      ```kotlin Kotlin theme={"system"}
      val settings = settings {
          exactOnSingleWordQuery = ExactOnSingleWordQuery.Attribute
          // exactOnSingleWordQuery = ExactOnSingleWordQuery.None
          // exactOnSingleWordQuery = ExactOnSingleWordQuery.Word
      }

      index.setSettings(settings)
      ```

      ```php PHP theme={"system"}
      $index->setSettings([
        'exactOnSingleWordQuery' => 'attribute'
        // 'exactOnSingleWordQuery' => 'none'
        // 'exactOnSingleWordQuery' => 'word'
      ]);
      ```

      ```python Python theme={"system"}
      index.set_settings(
          {
              "exactOnSingleWordQuery": "attribute"
              # 'exactOnSingleWordQuery': 'none'
              # 'exactOnSingleWordQuery': 'word'
          }
      )
      ```

      ```ruby Ruby theme={"system"}
      index.set_settings(
        {
          exactOnSingleWordQuery: "attribute"
          # exactOnSingleWordQuery: 'none'
          # exactOnSingleWordQuery: 'word'
        }
      )
      ```

      ```scala Scala theme={"system"}
      client.execute {
        setSettings of "myIndex" `with` IndexSettings(
          exactOnSingleWordQuery = Some("attribute")
          // exactOnSingleWordQuery = Some("none")
          // exactOnSingleWordQuery = Some("word")
        )
      }
      ```

      ```swift Swift theme={"system"}
      let settings = Settings()
        .set(\.exactOnSingleWordQuery, to: .attribute)
        //.set(\.exactOnSingleWordQuery, to: ExactOnSingleWordQuery.none)
        //.set(\.exactOnSingleWordQuery, to: .word)

      index.setSettings(settings) { result in
        if case .success(let response) = result {
          print("Response: \(response)")
        }
      }
      ```
    </CodeGroup>
  </Accordion>
</AccordionGroup>
