SearchConfigurationActions
SearchConfigurationActions
This is for:
DeveloperThe search configuration action creators.
See Dispatch Actions.
Loader Function
loadSearchConfigurationActions
Loads the necessary reducers and returns possible action creators.
Parameters
-
engine:
RecommendationEngine | SearchEngine
The headless engine.
Returns SearchConfigurationActionCreators
: The search configuration action creators.
SearchConfigurationActionCreators
updateSearchConfiguration
Updates the search configuration.
Parameters
-
payload:
UpdateSearchConfigurationActionCreatorPayload
The action creator payload.
Returns PayloadAction<UpdateSearchConfigurationActionCreatorPayload>
: A dispatchable action.
Related Types
UpdateSearchConfigurationActionCreatorPayload
Properties
-
authenticationProviders?:
string[]
Specifies the name of the authentication providers to use to perform queries.
See SAML Authentication.
-
locale?:
string
The locale of the current user. Must comply with IETF’s BCP 47 definition: https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
-
pipeline?:
string
The name of the query pipeline to use for the query (e.g.,
External Search
). -
proxyBaseUrl?:
string
The base URL to use to proxy Coveo search requests (e.g.,
https://example.com/search
).This is an advanced option that you should only set if you need to proxy Coveo searchrequests through your own server. In most cases, you should not set this option.
By default, no proxy is used and the Coveo Search API requests are sent directly to the Coveo platform through the search organization endpoint resolved from the
organizationId
andenvironment
values provided in your engine configuration (i.e.,https://<organizationId>.org.coveo.com
orhttps://<organizationId>.org<environment>.coveo.com
, if theenvironment
values is specified and different fromprod
).If you set this option, you must also implement the following proxy endpoints on your server, otherwise the search engine will not work properly:
-
POST
/
to proxy requests toPOST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2
-POST
/facet
to proxy requests toPOST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/facet
-GET
/fields
to proxy requests toGET
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/fields
-POST
/html
to proxy requests toPOST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/html
-POST
/plan
to proxy requests toPOST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/plan
-POST
/querySuggest
to proxy requests toPOST
https://<organizationId>.org<environment|>.coveo.com/rest/search/v2/querySuggest
-
-
searchHub?:
string
The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates (e.g.,
ExternalSearch
). -
timezone?:
string
The tz database identifier of the time zone of the user.