PUT /1/configs/{indexName}

Updates a QuerySuggestions configuration.

Servers

https://query-suggestions.{region}.algolia.com

Path parameters

Name	Type	Required	Description
`indexName`	String	Yes	Query Suggestions index name.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`allowSpecialCharacters`	Boolean	No	Whether to include suggestions with special characters. Default value: false
`sourceIndices[]`	Array	Yes	Algolia indices from which to get the popular searches for query suggestions.
`sourceIndices[].facets`		No	Facets to use as top categories with your suggestions. If provided, Query Suggestions adds the top facet values to each suggestion.
`sourceIndices[].generate`		No	Facets used for generating query suggestions from facet values. For example, if you set `generate: ["color", "brand"]`, combinations from the facet values are added as query suggestions, such as "blue adidas", "red adidas", "blue nike", "red nike", etc. You can include nested lists.
`sourceIndices[].minHits`	Integer	No	Minimum number of hits required to be included as a suggestion. A search query must at least generate `minHits` search results to be included in the Query Suggestions index. Default value: 5
`sourceIndices[].minLetters`	Integer	No	Minimum letters required to be included as a suggestion. A search query must be at least `minLetters` long to be included in the Query Suggestions index. Default value: 4
`sourceIndices[].indexName`	String	Yes	Name of the Algolia index (case-sensitive) to use as source for query suggestions.
`sourceIndices[].external`		No	Algolia indices with popular searches to use as query suggestions. Records of these indices must have these attributes: `query`: search query which will be added as a suggestion `count`: measure of popularity of that search query For example, you can export popular searches from an external analytics provider, such as Google Analytics or Adobe Analytics, and feed this data into an Algolia index. You can use this index to generate query suggestions until your Algolia Analytics has collected enough data.
`sourceIndices[].replicas`	Boolean	No	If true, Query Suggestions uses all replica indices to find popular searches. If false, only the primary index is used. Default value: false
`sourceIndices[].analyticsTags`		No	Analytics tags for filtering the popular searches. For more information, see Segment your analytics data.
`enablePersonalization`	Boolean	No	Whether to turn on personalized query suggestions. Default value: false
`languages`	Object	No	Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included. Default value: false
`exclude`	Object	No	Words or regular expressions to exclude from the suggestions.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.