VirtoCommerce.AzureSearch module implements ISearchProvider defined in the VirtoCommerce Search module and uses Azure Cognitive Search engine.
Azure Search provider are configurable by these configuration keys:
- Search.Provider is the name of the search provider and must be AzureSearch
- Search.AzureSearch.SearchServiceName is the name of the search service instance in your Azure account Ex: SERVICENAME.search.windows.net.
- Search.AzureSearch.AccessKey is the primary or secondary admin key for this search service.
- Search.AzureSearch.QueryParserType is type of Query Languages. Simple (default) or Full.
- Search.Scope is a common name (prefix) of all indexes. Each document type is stored in a separate index. Full index name is
scope-{documenttype}. One search service can serve multiple indexes.
Azure Cognitive Search implements two query languages:
The simple parser is more flexible and will attempt to interpret a request even if it's not perfectly composed. Because it's flexible, it's the default for queries in Azure Cognitive Search.
The Lucene/Full parser supports complex query formats, such as field-scoped queries, fuzzy search, infix and suffix wildcard search, proximity search, term boosting, and regular expression search. The additional power comes with additional processing requirements so you should expect a slightly longer execution time.
Azure Cognitive Search supports fuzzy search a type of query that compensates for typos and misspelled terms in the input string.
Two options to activate fuzzy search:
- Manually. Set
QueryParserTypetoFullin configuration and append a tilde character(~) after each whole term manually. Read about fuzzy query here - Automaticaly. Set
SearchRequest.IsFuzzySearchto true. Virto Commerce Azure Search Module activates Full query parser and adjust the query term with followed by a tilde (~) operator at the end of each whole term. For example, if your query (SearchRequest.SearchKeywords) has three terms "university of washington", the module adjusts every term in the query to "university~ of~ washington~".
The default distance (
SearchRequest.Fuzziness) is 2.
- Collections in a document can only contain strings. This means you cannot index a document with a collection of numbers.
- Document field names can only contain letters, digits and underscores. When indexing a document with invalid characters in a field name, all such characters will be replaced with an underscore, which can lead to duplicate fields.
- When
QueryParserTypeis set toFull, Lucene syntax rules are applied to the search string. In order to use any of the search operators as part of the search text, escape the character by prefixing it with a single backslash (\).
- Azure Search module user documentation
- Azure Search module developer documentation
- REST API
- Azure Search configuration
- View on GitHub
Copyright (c) Virto Solutions LTD. All rights reserved.
Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://virtocommerce.com/opensourcelicense
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.