models Package

Reference

Classes

AnalyzeResult	The result of testing an analyzer on text. All required parameters must be populated in order to send to Azure.
AnalyzeTextOptions	Specifies some text and analysis components used to break that text into tokens. All required parameters must be populated in order to send to Azure.
AnalyzedTokenInfo	Information about a token returned by an analyzer. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
AsciiFoldingTokenFilter	Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
CharFilter	Base type for character filters. You probably want to use the sub-classes and not this class directly. Known sub-classes are: MappingCharFilter, PatternReplaceCharFilter. All required parameters must be populated in order to send to Azure.
CjkBigramTokenFilter	Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
ClassicTokenizer	Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
CognitiveServicesAccount	Base type for describing any cognitive service resource attached to a skillset. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CognitiveServicesAccountKey, DefaultCognitiveServicesAccount. All required parameters must be populated in order to send to Azure.
CognitiveServicesAccountKey	A cognitive service resource provisioned with a key that is attached to a skillset. All required parameters must be populated in order to send to Azure.
CommonGramTokenFilter	Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
ConditionalSkill	A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output. All required parameters must be populated in order to send to Azure.
CorsOptions	Defines options to control Cross-Origin Resource Sharing (CORS) for an index. All required parameters must be populated in order to send to Azure.
CustomAnalyzer	Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer. All required parameters must be populated in order to send to Azure.
CustomEntityLookupSkill	A skill looks for text from a custom, user-defined list of words and phrases. All required parameters must be populated in order to send to Azure.
DefaultCognitiveServicesAccount	An empty object that represents the default cognitive service resource for a skillset. All required parameters must be populated in order to send to Azure.
DictionaryDecompounderTokenFilter	Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
DistanceScoringFunction	Defines a function that boosts scores based on distance from a geographic location. All required parameters must be populated in order to send to Azure.
DistanceScoringParameters	Provides parameter values to a distance scoring function. All required parameters must be populated in order to send to Azure.
DocumentExtractionSkill	A skill that extracts content from a file within the enrichment pipeline. All required parameters must be populated in order to send to Azure.
EdgeNGramTokenFilter	Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
EdgeNGramTokenizer	Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
ElisionTokenFilter	Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
EntityRecognitionSkill	Text analytics entity recognition. All required parameters must be populated in order to send to Azure.
FieldMapping	Defines a mapping between a field in a data source and a target field in an index. All required parameters must be populated in order to send to Azure.
FieldMappingFunction	Represents a function that transforms a value from a data source before indexing. All required parameters must be populated in order to send to Azure.
FreshnessScoringFunction	Defines a function that boosts scores based on the value of a date-time field. All required parameters must be populated in order to send to Azure.
FreshnessScoringParameters	Provides parameter values to a freshness scoring function. All required parameters must be populated in order to send to Azure.
GetIndexStatisticsResult	Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
ImageAnalysisSkill	A skill that analyzes image files. It extracts a rich set of visual features based on the image content. All required parameters must be populated in order to send to Azure.
IndexingParameters	Represents parameters for indexer execution.
IndexingSchedule	Represents a schedule for indexer execution. All required parameters must be populated in order to send to Azure.
InputFieldMappingEntry	Input field mapping for a skill. All required parameters must be populated in order to send to Azure.
KeepTokenFilter	A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
KeyPhraseExtractionSkill	A skill that uses text analytics for key phrase extraction. All required parameters must be populated in order to send to Azure.
KeywordMarkerTokenFilter	Marks terms as keywords. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
LanguageDetectionSkill	A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis. All required parameters must be populated in order to send to Azure.
LengthTokenFilter	Removes words that are too long or too short. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
LexicalAnalyzer	Base type for analyzers. You probably want to use the sub-classes and not this class directly. Known sub-classes are: CustomAnalyzer, PatternAnalyzer, LuceneStandardAnalyzer, StopAnalyzer. All required parameters must be populated in order to send to Azure.
LexicalTokenizer	Base type for tokenizers. You probably want to use the sub-classes and not this class directly. Known sub-classes are: ClassicTokenizer, EdgeNGramTokenizer, KeywordTokenizer, KeywordTokenizerV2, MicrosoftLanguageStemmingTokenizer, MicrosoftLanguageTokenizer, NGramTokenizer, PathHierarchyTokenizerV2, PatternTokenizer, LuceneStandardTokenizer, LuceneStandardTokenizerV2, UaxUrlEmailTokenizer. All required parameters must be populated in order to send to Azure.
LimitTokenFilter	Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
LuceneStandardAnalyzer	Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. All required parameters must be populated in order to send to Azure.
LuceneStandardTokenizer	Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
MagnitudeScoringFunction	Defines a function that boosts scores based on the magnitude of a numeric field. All required parameters must be populated in order to send to Azure.
MagnitudeScoringParameters	Provides parameter values to a magnitude scoring function. All required parameters must be populated in order to send to Azure.
MappingCharFilter	A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
MergeSkill	A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part. All required parameters must be populated in order to send to Azure.
MicrosoftLanguageStemmingTokenizer	Divides text using language-specific rules and reduces words to their base forms. All required parameters must be populated in order to send to Azure.
MicrosoftLanguageTokenizer	Divides text using language-specific rules. All required parameters must be populated in order to send to Azure.
NGramTokenFilter	Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
NGramTokenizer	Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
OcrSkill	A skill that extracts text from image files. All required parameters must be populated in order to send to Azure.
OutputFieldMappingEntry	Output field mapping for a skill. All required parameters must be populated in order to send to Azure.
PatternAnalyzer	Flexibly separates text into terms via a regular expression. This analyzer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
PatternCaptureTokenFilter	Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
PatternReplaceCharFilter	A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This character filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
PatternReplaceTokenFilter	A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
PatternTokenizer	Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
PhoneticTokenFilter	Create tokens for phonetic matches. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
ScoringFunction	Base type for functions that can modify document scores during ranking. You probably want to use the sub-classes and not this class directly. Known sub-classes are: DistanceScoringFunction, FreshnessScoringFunction, MagnitudeScoringFunction, TagScoringFunction. All required parameters must be populated in order to send to Azure.
ScoringProfile	Defines parameters for a search index that influence scoring in search queries. All required parameters must be populated in order to send to Azure.
SearchField	Represents a field in an index definition, which describes the name, data type, and search behavior of a field. All required parameters must be populated in order to send to Azure.
SearchIndex	Represents a search index definition, which describes the fields and search behavior of an index. All required parameters must be populated in order to send to Azure.
SearchIndexer	Represents an indexer. All required parameters must be populated in order to send to Azure.
SearchIndexerDataContainer	Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed. All required parameters must be populated in order to send to Azure.
SearchIndexerDataSourceConnection	Represents a datasource connection definition, which can be used to configure an indexer. All required parameters must be populated in order to send to Azure.
SearchIndexerError	Represents an item- or document-level indexing error. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
SearchIndexerKnowledgeStore	Definition of additional projections to azure blob, table, or files, of enriched data. All required parameters must be populated in order to send to Azure.
SearchIndexerKnowledgeStoreFileProjectionSelector	Projection definition for what data to store in Azure Files. All required parameters must be populated in order to send to Azure.
SearchIndexerKnowledgeStoreObjectProjectionSelector	Projection definition for what data to store in Azure Blob. All required parameters must be populated in order to send to Azure.
SearchIndexerKnowledgeStoreProjection	Container object for various projection selectors.
SearchIndexerKnowledgeStoreTableProjectionSelector	Description for what data to store in Azure Tables. All required parameters must be populated in order to send to Azure.
SearchIndexerLimits	SearchIndexerLimits. Variables are only populated by the server, and will be ignored when sending a request.
SearchIndexerSkillset	A list of skills. All required parameters must be populated in order to send to Azure.
SearchIndexerStatus	Represents the current status and execution history of an indexer. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
SearchResourceEncryptionKey	A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps. All required parameters must be populated in order to send to Azure.
SentimentSkill	Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. All required parameters must be populated in order to send to Azure.
ShaperSkill	A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields). All required parameters must be populated in order to send to Azure.
ShingleTokenFilter	Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
SnowballTokenFilter	A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
SoftDeleteColumnDeletionDetectionPolicy	Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column. All required parameters must be populated in order to send to Azure.
SplitSkill	A skill to split a string into chunks of text. All required parameters must be populated in order to send to Azure.
SqlIntegratedChangeTrackingPolicy	Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database. All required parameters must be populated in order to send to Azure.
StemmerOverrideTokenFilter	Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
StemmerTokenFilter	Language specific stemming filter. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
StopAnalyzer	Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
StopwordsTokenFilter	Removes stop words from a token stream. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
SuggestOptions	Parameter group.
SynonymMap	Represents a synonym map definition. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
SynonymTokenFilter	Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
TagScoringFunction	Defines a function that boosts scores of documents with string values matching a given list of tags. All required parameters must be populated in order to send to Azure.
TagScoringParameters	Provides parameter values to a tag scoring function. All required parameters must be populated in order to send to Azure.
TextTranslationSkill	A skill to translate text from one language to another. All required parameters must be populated in order to send to Azure.
TextWeights	Defines weights on index fields for which matches should boost scoring in search queries. All required parameters must be populated in order to send to Azure.
TokenFilter	Base type for token filters. You probably want to use the sub-classes and not this class directly. Known sub-classes are: AsciiFoldingTokenFilter, CjkBigramTokenFilter, CommonGramTokenFilter, DictionaryDecompounderTokenFilter, EdgeNGramTokenFilter, EdgeNGramTokenFilterV2, ElisionTokenFilter, KeepTokenFilter, KeywordMarkerTokenFilter, LengthTokenFilter, LimitTokenFilter, NGramTokenFilter, NGramTokenFilterV2, PatternCaptureTokenFilter, PatternReplaceTokenFilter, PhoneticTokenFilter, ShingleTokenFilter, SnowballTokenFilter, StemmerOverrideTokenFilter, StemmerTokenFilter, StopwordsTokenFilter, SynonymTokenFilter, TruncateTokenFilter, UniqueTokenFilter, WordDelimiterTokenFilter. All required parameters must be populated in order to send to Azure.
TruncateTokenFilter	Truncates the terms to a specific length. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
UaxUrlEmailTokenizer	Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
UniqueTokenFilter	Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.
WebApiSkill	A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code. All required parameters must be populated in order to send to Azure.
WordDelimiterTokenFilter	Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene. All required parameters must be populated in order to send to Azure.

Enums

EdgeNGramTokenFilterSide	Specifies which side of the input an n-gram should be generated from.
EntityCategory	A string indicating what entity categories to return.
EntityRecognitionSkillLanguage	The language codes supported for input text by EntityRecognitionSkill.
ImageAnalysisSkillLanguage	The language codes supported for input by ImageAnalysisSkill.
ImageDetail	A string indicating which domain-specific details to return.
IndexerExecutionStatus	Represents the status of an individual indexer execution.
IndexerStatus	Represents the overall indexer status.
KeyPhraseExtractionSkillLanguage	The language codes supported for input text by KeyPhraseExtractionSkill.
MicrosoftStemmingTokenizerLanguage	Lists the languages supported by the Microsoft language stemming tokenizer.
MicrosoftTokenizerLanguage	Lists the languages supported by the Microsoft language tokenizer.
OcrSkillLanguage	The language codes supported for input by OcrSkill.
PhoneticEncoder	Identifies the type of phonetic encoder to use with a PhoneticTokenFilter.
RegexFlags	Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.
ScoringFunctionAggregation	Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile.
ScoringFunctionInterpolation	Defines the function used to interpolate score boosting across a range of documents.
SearchIndexerDataSourceType	Defines the type of a datasource.
SentimentSkillLanguage	The language codes supported for input text by SentimentSkill.
SnowballTokenFilterLanguage	The language to use for a Snowball token filter.
SplitSkillLanguage	The language codes supported for input text by SplitSkill.
StemmerTokenFilterLanguage	The language to use for a stemmer token filter.
StopwordsList	Identifies a predefined list of language-specific stopwords.
TextSplitMode	A value indicating which split mode to perform.
TextTranslationSkillLanguage	The language codes supported for input text by TextTranslationSkill.
TokenCharacterKind	Represents classes of characters on which a token filter can operate.
TokenFilterName	Defines the names of all token filters supported by Azure Cognitive Search.
VisualFeature	The strings indicating what visual feature types to return.

Functions

ComplexField

Configure a Complex or Complex collection field for an Azure Search Index

ComplexField(**kw: Any) -> SearchField

Parameters

name: str

Required

Required. The name of the field, which must be unique within the fields collection of the index or parent field.

collection: bool

Required

Whether this complex field is a collection (default False)

fields: list[<xref:search_service_client.models.Field>]

Required

A list of sub-fields

SearchableField

Configure a searchable text field for an Azure Search Index

SearchableField(**kw: Any) -> SearchField

Parameters

name: str

Required

Required. The name of the field, which must be unique within the fields collection of the index or parent field.

collection: bool

Required

Whether this search field is a collection (default False)

key: bool

Required

A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type SearchFieldDataType.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is False

hidden: bool

Required

A value indicating whether the field can be returned in a search result. You can enable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be False for key fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is False.

searchable: bool

Required

A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. Default is True.

filterable: bool

Required

A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. Default is False.

sortable: bool

Required

facetable: bool

Required

A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). Default is False.

analyzer_name: str or <xref:azure.search.documents.indexes.models.AnalyzerName>

Required

The name of the analyzer to use for the field. This option can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Possible values include: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene', 'zh- Hans.microsoft', 'zh-Hans.lucene', 'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene', 'el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene', 'pt- PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft', 'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft', 'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene', 'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene', 'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft', 'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene', 'keyword', 'pattern', 'simple', 'stop', 'whitespace'.

search_analyzer_name: str or <xref:azure.search.documents.indexes.models.AnalyzerName>

Required

The name of the analyzer used at search time for the field. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Possible values include: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene', 'zh- Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene', 'el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene', 'pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr- cyrillic.microsoft', 'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft', 'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene', 'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene', 'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft', 'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene', 'keyword', 'pattern', 'simple', 'stop', 'whitespace'.

index_analyzer_name: str or <xref:azure.search.documents.indexes.models.AnalyzerName>

Required

The name of the analyzer used at indexing time for the field. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Possible values include: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft', 'ca.lucene', 'zh-Hans.microsoft', 'zh- Hans.lucene', 'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft', 'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene', 'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene', 'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft', 'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene', 'el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft', 'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene', 'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene', 'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene', 'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft', 'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft', 'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene', 'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene', 'pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft', 'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr- cyrillic.microsoft', 'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft', 'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene', 'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene', 'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft', 'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene', 'keyword', 'pattern', 'simple', 'stop', 'whitespace'.

synonym_map_names: list[str]

Required

A list of the names of synonym maps to associate with this field. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields.

SimpleField

Configure a simple field for an Azure Search Index

SimpleField(**kw: Any) -> SearchField

Parameters

name: str

Required

Required. The name of the field, which must be unique within the fields collection of the index or parent field.

type

Required

Required. The data type of the field. Possible values include: SearchFieldDataType.String, SearchFieldDataType.Int32, SearchFieldDataType.Int64, SearchFieldDataType.Double, SearchFieldDataType.Boolean, SearchFieldDataType.DateTimeOffset, SearchFieldDataType.GeographyPoint, SearchFieldDataType.ComplexType, from azure.search.documents.SearchFieldDataType. :type type: str

key: bool

Required

hidden: bool

Required

filterable: bool

Required

A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type SearchFieldDataType.String or Collection(SearchFieldDataType.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is False

sortable: bool

Required

A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. The default is False.

facetable: bool

Required

models Package

Classes

Enums

Functions

ComplexField

Parameters

SearchableField

Parameters

SimpleField

Parameters

Feedback