enableABTest

Whether the current search should participate in running A/B tests.

The enableABTest parameter lets you exclude the current search from participating in running A/B tests.

Example

Current API clients

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "INDEX_NAME",
  new SearchParams(new SearchParamsObject { Query = "query", EnableABTest = false })
);

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    enableABTest: false,
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetEnableABTest(false))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setEnableABTest(false),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', enableABTest: false },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", enableABTest = false),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'enableABTest' => false,
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "enableABTest": False,
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", enable_ab_test: false)
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        enableABTest = Some(false)
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        enableABTest: false
    ))
)

Legacy API clients

C#

index.Search(new Query("")
{
    EnableABTest = false
});

res, err := index.Search(
	"query",
	opt.EnableABTest(false),
)

index.search(
  new Query("query")
    .setEnableABTest(false)
);

index
  .search("query", {
    enableABTest: false,
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    enableABTest = false
}

index.search(query)

$results = $index->search('query', [
  'enableABTest' => false
]);

results = index.search("query", {"enableABTest": False})

results = index.search(
  "query",
  {
    enableABTest: false
  }
)

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    enableABTest = Some(false)
  )
}

let query = Query("query")
  .set(\.enableABTest, to: false)

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}