Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/search

Package version

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AnalyzerName

AnalyzerName: "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"

Defines values for AnalyzerName. 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'

readonly

AnalyzerUnion

Contains the possible cases for Analyzer.

AutocompleteMode

AutocompleteMode: "oneTerm" | "twoTerms" | "oneTermWithContext"

Defines values for AutocompleteMode. Possible values include: 'oneTerm', 'twoTerms', 'oneTermWithContext'

readonly

CharFilterName

CharFilterName: "html_strip"

Defines values for CharFilterName. Possible values include: 'HtmlStrip'

readonly

CharFilterUnion

Contains the possible cases for CharFilter.

CjkBigramTokenFilterScripts

CjkBigramTokenFilterScripts: "han" | "hiragana" | "katakana" | "hangul"

Defines values for CjkBigramTokenFilterScripts. Possible values include: 'han', 'hiragana', 'katakana', 'hangul'

readonly

CognitiveServicesAccountUnion

Contains the possible cases for CognitiveServicesAccount.

CountDocumentsOptions

CountDocumentsOptions: OperationOptions

Options for performing the count operation on the index.

DataChangeDetectionPolicyUnion

Contains the possible cases for DataChangeDetectionPolicy.

DataDeletionDetectionPolicyUnion

Contains the possible cases for DataDeletionDetectionPolicy.

DataSourceType

DataSourceType: "azuresql" | "cosmosdb" | "azureblob" | "azuretable"

Defines values for DataSourceType. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable'

readonly

DataSourcesCreateOrUpdateResponse

DataSourcesCreateOrUpdateResponse: DataSource & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DataSource } }

Contains response data for the createOrUpdate operation.

DataSourcesCreateResponse

DataSourcesCreateResponse: DataSource & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DataSource } }

Contains response data for the create operation.

DataSourcesGetResponse

DataSourcesGetResponse: DataSource & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: DataSource } }

Contains response data for the get operation.

DataSourcesListResponse

DataSourcesListResponse: ListDataSourcesResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListDataSourcesResult } }

Contains response data for the list operation.

DataType

DataType: "Edm.String" | "Edm.Int32" | "Edm.Int64" | "Edm.Double" | "Edm.Boolean" | "Edm.DateTimeOffset" | "Edm.GeographyPoint" | "Edm.ComplexType"

Defines values for DataType. Possible values include: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Edm.ComplexType'

readonly

DeleteDocumentsOptions

DeleteDocumentsOptions: IndexDocuments

Options for the delete documents operation.

DocumentsAutocompleteGetResponse

DocumentsAutocompleteGetResponse: AutocompleteResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AutocompleteResult } }

Contains response data for the autocompleteGet operation.

DocumentsAutocompletePostResponse

DocumentsAutocompletePostResponse: AutocompleteResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AutocompleteResult } }

Contains response data for the autocompletePost operation.

DocumentsCountResponse

DocumentsCountResponse: { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: number }; body: number }

Contains response data for the count operation.

Type declaration

  • _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: number }

    The underlying HTTP response.

  • body: number

    The parsed response body.

DocumentsGetResponse

DocumentsGetResponse: { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any }; body: any }

Contains response data for the get operation.

Type declaration

  • _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: any }

    The underlying HTTP response.

  • body: any

    The parsed response body.

DocumentsIndexResponse

DocumentsIndexResponse: IndexDocumentsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: IndexDocumentsResult } }

Contains response data for the index operation.

DocumentsSearchGetResponse

DocumentsSearchGetResponse: SearchDocumentsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SearchDocumentsResult } }

Contains response data for the searchGet operation.

DocumentsSearchPostResponse

DocumentsSearchPostResponse: SearchDocumentsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SearchDocumentsResult } }

Contains response data for the searchPost operation.

DocumentsSuggestGetResponse

DocumentsSuggestGetResponse: SuggestDocumentsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SuggestDocumentsResult } }

Contains response data for the suggestGet operation.

DocumentsSuggestPostResponse

DocumentsSuggestPostResponse: SuggestDocumentsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SuggestDocumentsResult } }

Contains response data for the suggestPost operation.

EdgeNGramTokenFilterSide

EdgeNGramTokenFilterSide: "front" | "back"

Defines values for EdgeNGramTokenFilterSide. Possible values include: 'front', 'back'

readonly

EntityCategory

EntityCategory: "location" | "organization" | "person" | "quantity" | "datetime" | "url" | "email"

Defines values for EntityCategory. Possible values include: 'location', 'organization', 'person', 'quantity', 'datetime', 'url', 'email'

readonly

EntityRecognitionSkillLanguage

EntityRecognitionSkillLanguage: "ar" | "cs" | "zh-Hans" | "zh-Hant" | "da" | "nl" | "en" | "fi" | "fr" | "de" | "el" | "hu" | "it" | "ja" | "ko" | "no" | "pl" | "pt-PT" | "pt-BR" | "ru" | "es" | "sv" | "tr"

Defines values for EntityRecognitionSkillLanguage. Possible values include: 'ar', 'cs', 'zh-Hans', 'zh-Hant', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'no', 'pl', 'pt-PT', 'pt-BR', 'ru', 'es', 'sv', 'tr'

readonly

GetServiceStatisticsResponse

GetServiceStatisticsResponse: ServiceStatistics & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ServiceStatistics } }

Contains response data for the getServiceStatistics operation.

ImageAnalysisSkillLanguage

ImageAnalysisSkillLanguage: "en" | "zh"

Defines values for ImageAnalysisSkillLanguage. Possible values include: 'en', 'zh'

readonly

ImageDetail

ImageDetail: "celebrities" | "landmarks"

Defines values for ImageDetail. Possible values include: 'celebrities', 'landmarks'

readonly

IndexActionType

IndexActionType: "upload" | "merge" | "mergeOrUpload" | "delete"

Defines values for IndexActionType. Possible values include: 'upload', 'merge', 'mergeOrUpload', 'delete'

readonly

IndexerExecutionStatus

IndexerExecutionStatus: "transientFailure" | "success" | "inProgress" | "reset"

Defines values for IndexerExecutionStatus. Possible values include: 'transientFailure', 'success', 'inProgress', 'reset'

readonly

IndexerStatus

IndexerStatus: "unknown" | "error" | "running"

Defines values for IndexerStatus. Possible values include: 'unknown', 'error', 'running'

readonly

IndexersCreateOrUpdateResponse

IndexersCreateOrUpdateResponse: Indexer & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Indexer } }

Contains response data for the createOrUpdate operation.

IndexersCreateResponse

IndexersCreateResponse: Indexer & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Indexer } }

Contains response data for the create operation.

IndexersGetResponse

IndexersGetResponse: Indexer & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Indexer } }

Contains response data for the get operation.

IndexersGetStatusResponse

IndexersGetStatusResponse: IndexerExecutionInfo & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: IndexerExecutionInfo } }

Contains response data for the getStatus operation.

IndexersListResponse

IndexersListResponse: ListIndexersResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListIndexersResult } }

Contains response data for the list operation.

IndexesAnalyzeResponse

IndexesAnalyzeResponse: AnalyzeResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: AnalyzeResult } }

Contains response data for the analyze operation.

IndexesCreateOrUpdateResponse

IndexesCreateOrUpdateResponse: Index & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Index } }

Contains response data for the createOrUpdate operation.

IndexesCreateResponse

IndexesCreateResponse: Index & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Index } }

Contains response data for the create operation.

IndexesGetResponse

IndexesGetResponse: Index & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Index } }

Contains response data for the get operation.

IndexesGetStatisticsResponse

IndexesGetStatisticsResponse: GetIndexStatisticsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: GetIndexStatisticsResult } }

Contains response data for the getStatistics operation.

IndexesListResponse

IndexesListResponse: ListIndexesResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListIndexesResult } }

Contains response data for the list operation.

KeyPhraseExtractionSkillLanguage

KeyPhraseExtractionSkillLanguage: "da" | "nl" | "en" | "fi" | "fr" | "de" | "it" | "ja" | "ko" | "no" | "pl" | "pt-PT" | "pt-BR" | "ru" | "es" | "sv"

Defines values for KeyPhraseExtractionSkillLanguage. Possible values include: 'da', 'nl', 'en', 'fi', 'fr', 'de', 'it', 'ja', 'ko', 'no', 'pl', 'pt-PT', 'pt-BR', 'ru', 'es', 'sv'

readonly

MicrosoftStemmingTokenizerLanguage

MicrosoftStemmingTokenizerLanguage: "arabic" | "bangla" | "bulgarian" | "catalan" | "croatian" | "czech" | "danish" | "dutch" | "english" | "estonian" | "finnish" | "french" | "german" | "greek" | "gujarati" | "hebrew" | "hindi" | "hungarian" | "icelandic" | "indonesian" | "italian" | "kannada" | "latvian" | "lithuanian" | "malay" | "malayalam" | "marathi" | "norwegianBokmaal" | "polish" | "portuguese" | "portugueseBrazilian" | "punjabi" | "romanian" | "russian" | "serbianCyrillic" | "serbianLatin" | "slovak" | "slovenian" | "spanish" | "swedish" | "tamil" | "telugu" | "turkish" | "ukrainian" | "urdu"

Defines values for MicrosoftStemmingTokenizerLanguage. Possible values include: 'arabic', 'bangla', 'bulgarian', 'catalan', 'croatian', 'czech', 'danish', 'dutch', 'english', 'estonian', 'finnish', 'french', 'german', 'greek', 'gujarati', 'hebrew', 'hindi', 'hungarian', 'icelandic', 'indonesian', 'italian', 'kannada', 'latvian', 'lithuanian', 'malay', 'malayalam', 'marathi', 'norwegianBokmaal', 'polish', 'portuguese', 'portugueseBrazilian', 'punjabi', 'romanian', 'russian', 'serbianCyrillic', 'serbianLatin', 'slovak', 'slovenian', 'spanish', 'swedish', 'tamil', 'telugu', 'turkish', 'ukrainian', 'urdu'

readonly

MicrosoftTokenizerLanguage

MicrosoftTokenizerLanguage: "bangla" | "bulgarian" | "catalan" | "chineseSimplified" | "chineseTraditional" | "croatian" | "czech" | "danish" | "dutch" | "english" | "french" | "german" | "greek" | "gujarati" | "hindi" | "icelandic" | "indonesian" | "italian" | "japanese" | "kannada" | "korean" | "malay" | "malayalam" | "marathi" | "norwegianBokmaal" | "polish" | "portuguese" | "portugueseBrazilian" | "punjabi" | "romanian" | "russian" | "serbianCyrillic" | "serbianLatin" | "slovenian" | "spanish" | "swedish" | "tamil" | "telugu" | "thai" | "ukrainian" | "urdu" | "vietnamese"

Defines values for MicrosoftTokenizerLanguage. Possible values include: 'bangla', 'bulgarian', 'catalan', 'chineseSimplified', 'chineseTraditional', 'croatian', 'czech', 'danish', 'dutch', 'english', 'french', 'german', 'greek', 'gujarati', 'hindi', 'icelandic', 'indonesian', 'italian', 'japanese', 'kannada', 'korean', 'malay', 'malayalam', 'marathi', 'norwegianBokmaal', 'polish', 'portuguese', 'portugueseBrazilian', 'punjabi', 'romanian', 'russian', 'serbianCyrillic', 'serbianLatin', 'slovenian', 'spanish', 'swedish', 'tamil', 'telugu', 'thai', 'ukrainian', 'urdu', 'vietnamese'

readonly

OcrSkillLanguage

OcrSkillLanguage: "zh-Hans" | "zh-Hant" | "cs" | "da" | "nl" | "en" | "fi" | "fr" | "de" | "el" | "hu" | "it" | "ja" | "ko" | "nb" | "pl" | "pt" | "ru" | "es" | "sv" | "tr" | "ar" | "ro" | "sr-Cyrl" | "sr-Latn" | "sk"

Defines values for OcrSkillLanguage. Possible values include: 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

readonly

OperationTracingOptions

OperationTracingOptions: OperationOptions["tracingOptions"]

PhoneticEncoder

PhoneticEncoder: "metaphone" | "doubleMetaphone" | "soundex" | "refinedSoundex" | "caverphone1" | "caverphone2" | "cologne" | "nysiis" | "koelnerPhonetik" | "haasePhonetik" | "beiderMorse"

Defines values for PhoneticEncoder. Possible values include: 'metaphone', 'doubleMetaphone', 'soundex', 'refinedSoundex', 'caverphone1', 'caverphone2', 'cologne', 'nysiis', 'koelnerPhonetik', 'haasePhonetik', 'beiderMorse'

readonly

QueryType

QueryType: "simple" | "full"

Defines values for QueryType. Possible values include: 'simple', 'full'

readonly

RegexFlags

RegexFlags: "CANON_EQ" | "CASE_INSENSITIVE" | "COMMENTS" | "DOTALL" | "LITERAL" | "MULTILINE" | "UNICODE_CASE" | "UNIX_LINES"

Defines values for RegexFlags. Possible values include: 'CANON_EQ', 'CASE_INSENSITIVE', 'COMMENTS', 'DOTALL', 'LITERAL', 'MULTILINE', 'UNICODE_CASE', 'UNIX_LINES'

readonly

ScoringFunctionAggregation

ScoringFunctionAggregation: "sum" | "average" | "minimum" | "maximum" | "firstMatching"

Defines values for ScoringFunctionAggregation. Possible values include: 'sum', 'average', 'minimum', 'maximum', 'firstMatching'

readonly

ScoringFunctionInterpolation

ScoringFunctionInterpolation: "linear" | "constant" | "quadratic" | "logarithmic"

Defines values for ScoringFunctionInterpolation. Possible values include: 'linear', 'constant', 'quadratic', 'logarithmic'

readonly

ScoringFunctionUnion

Contains the possible cases for ScoringFunction.

SearchIndexClientOptions

SearchIndexClientOptions: PipelineOptions

Client options used to configure Cognitive Search API requests.

SearchIterator

SearchIterator<Fields>: PagedAsyncIterableIterator<SearchResult<Fields>, SearchDocumentsPageResult<Fields>, ListSearchResultsPageSettings>

An iterator for search results of a paticular query. Will make requests as needed during iteration. Use .byPage() to make one request to the server per iteration.

Type parameters

  • Fields

SearchMode

SearchMode: "any" | "all"

Defines values for SearchMode. Possible values include: 'any', 'all'

readonly

SentimentSkillLanguage

SentimentSkillLanguage: "da" | "nl" | "en" | "fi" | "fr" | "de" | "el" | "it" | "no" | "pl" | "pt-PT" | "ru" | "es" | "sv" | "tr"

Defines values for SentimentSkillLanguage. Possible values include: 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'it', 'no', 'pl', 'pt-PT', 'ru', 'es', 'sv', 'tr'

readonly

SkillUnion

Contains the possible cases for Skill.

SkillsetsCreateOrUpdateResponse

SkillsetsCreateOrUpdateResponse: Skillset & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Skillset } }

Contains response data for the createOrUpdate operation.

SkillsetsCreateResponse

SkillsetsCreateResponse: Skillset & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Skillset } }

Contains response data for the create operation.

SkillsetsGetResponse

SkillsetsGetResponse: Skillset & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: Skillset } }

Contains response data for the get operation.

SkillsetsListResponse

SkillsetsListResponse: ListSkillsetsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListSkillsetsResult } }

Contains response data for the list operation.

SnowballTokenFilterLanguage

SnowballTokenFilterLanguage: "armenian" | "basque" | "catalan" | "danish" | "dutch" | "english" | "finnish" | "french" | "german" | "german2" | "hungarian" | "italian" | "kp" | "lovins" | "norwegian" | "porter" | "portuguese" | "romanian" | "russian" | "spanish" | "swedish" | "turkish"

Defines values for SnowballTokenFilterLanguage. Possible values include: 'armenian', 'basque', 'catalan', 'danish', 'dutch', 'english', 'finnish', 'french', 'german', 'german2', 'hungarian', 'italian', 'kp', 'lovins', 'norwegian', 'porter', 'portuguese', 'romanian', 'russian', 'spanish', 'swedish', 'turkish'

readonly

SplitSkillLanguage

SplitSkillLanguage: "da" | "de" | "en" | "es" | "fi" | "fr" | "it" | "ko" | "pt"

Defines values for SplitSkillLanguage. Possible values include: 'da', 'de', 'en', 'es', 'fi', 'fr', 'it', 'ko', 'pt'

readonly

StemmerTokenFilterLanguage

StemmerTokenFilterLanguage: "arabic" | "armenian" | "basque" | "brazilian" | "bulgarian" | "catalan" | "czech" | "danish" | "dutch" | "dutchKp" | "english" | "lightEnglish" | "minimalEnglish" | "possessiveEnglish" | "porter2" | "lovins" | "finnish" | "lightFinnish" | "french" | "lightFrench" | "minimalFrench" | "galician" | "minimalGalician" | "german" | "german2" | "lightGerman" | "minimalGerman" | "greek" | "hindi" | "hungarian" | "lightHungarian" | "indonesian" | "irish" | "italian" | "lightItalian" | "sorani" | "latvian" | "norwegian" | "lightNorwegian" | "minimalNorwegian" | "lightNynorsk" | "minimalNynorsk" | "portuguese" | "lightPortuguese" | "minimalPortuguese" | "portugueseRslp" | "romanian" | "russian" | "lightRussian" | "spanish" | "lightSpanish" | "swedish" | "lightSwedish" | "turkish"

Defines values for StemmerTokenFilterLanguage. Possible values include: 'arabic', 'armenian', 'basque', 'brazilian', 'bulgarian', 'catalan', 'czech', 'danish', 'dutch', 'dutchKp', 'english', 'lightEnglish', 'minimalEnglish', 'possessiveEnglish', 'porter2', 'lovins', 'finnish', 'lightFinnish', 'french', 'lightFrench', 'minimalFrench', 'galician', 'minimalGalician', 'german', 'german2', 'lightGerman', 'minimalGerman', 'greek', 'hindi', 'hungarian', 'lightHungarian', 'indonesian', 'irish', 'italian', 'lightItalian', 'sorani', 'latvian', 'norwegian', 'lightNorwegian', 'minimalNorwegian', 'lightNynorsk', 'minimalNynorsk', 'portuguese', 'lightPortuguese', 'minimalPortuguese', 'portugueseRslp', 'romanian', 'russian', 'lightRussian', 'spanish', 'lightSpanish', 'swedish', 'lightSwedish', 'turkish'

readonly

StopwordsList

StopwordsList: "arabic" | "armenian" | "basque" | "brazilian" | "bulgarian" | "catalan" | "czech" | "danish" | "dutch" | "english" | "finnish" | "french" | "galician" | "german" | "greek" | "hindi" | "hungarian" | "indonesian" | "irish" | "italian" | "latvian" | "norwegian" | "persian" | "portuguese" | "romanian" | "russian" | "sorani" | "spanish" | "swedish" | "thai" | "turkish"

Defines values for StopwordsList. Possible values include: 'arabic', 'armenian', 'basque', 'brazilian', 'bulgarian', 'catalan', 'czech', 'danish', 'dutch', 'english', 'finnish', 'french', 'galician', 'german', 'greek', 'hindi', 'hungarian', 'indonesian', 'irish', 'italian', 'latvian', 'norwegian', 'persian', 'portuguese', 'romanian', 'russian', 'sorani', 'spanish', 'swedish', 'thai', 'turkish'

readonly

SynonymMapsCreateOrUpdateResponse

SynonymMapsCreateOrUpdateResponse: SynonymMap & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SynonymMap } }

Contains response data for the createOrUpdate operation.

SynonymMapsCreateResponse

SynonymMapsCreateResponse: SynonymMap & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SynonymMap } }

Contains response data for the create operation.

SynonymMapsGetResponse

SynonymMapsGetResponse: SynonymMap & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SynonymMap } }

Contains response data for the get operation.

SynonymMapsListResponse

SynonymMapsListResponse: ListSynonymMapsResult & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: ListSynonymMapsResult } }

Contains response data for the list operation.

TextExtractionAlgorithm

TextExtractionAlgorithm: "printed" | "handwritten"

Defines values for TextExtractionAlgorithm. Possible values include: 'printed', 'handwritten'

readonly

TextSplitMode

TextSplitMode: "pages" | "sentences"

Defines values for TextSplitMode. Possible values include: 'pages', 'sentences'

readonly

TextTranslationSkillLanguage

TextTranslationSkillLanguage: "af" | "ar" | "bn" | "bs" | "bg" | "yue" | "ca" | "zh-Hans" | "zh-Hant" | "hr" | "cs" | "da" | "nl" | "en" | "et" | "fj" | "fil" | "fi" | "fr" | "de" | "el" | "ht" | "he" | "hi" | "mww" | "hu" | "is" | "id" | "it" | "ja" | "sw" | "tlh" | "ko" | "lv" | "lt" | "mg" | "ms" | "mt" | "nb" | "fa" | "pl" | "pt" | "otq" | "ro" | "ru" | "sm" | "sr-Cyrl" | "sr-Latn" | "sk" | "sl" | "es" | "sv" | "ty" | "ta" | "te" | "th" | "to" | "tr" | "uk" | "ur" | "vi" | "cy" | "yua"

Defines values for TextTranslationSkillLanguage. Possible values include: 'af', 'ar', 'bn', 'bs', 'bg', 'yue', 'ca', 'zh-Hans', 'zh-Hant', 'hr', 'cs', 'da', 'nl', 'en', 'et', 'fj', 'fil', 'fi', 'fr', 'de', 'el', 'ht', 'he', 'hi', 'mww', 'hu', 'is', 'id', 'it', 'ja', 'sw', 'tlh', 'ko', 'lv', 'lt', 'mg', 'ms', 'mt', 'nb', 'fa', 'pl', 'pt', 'otq', 'ro', 'ru', 'sm', 'sr-Cyrl', 'sr-Latn', 'sk', 'sl', 'es', 'sv', 'ty', 'ta', 'te', 'th', 'to', 'tr', 'uk', 'ur', 'vi', 'cy', 'yua'

readonly

TokenCharacterKind

TokenCharacterKind: "letter" | "digit" | "whitespace" | "punctuation" | "symbol"

Defines values for TokenCharacterKind. Possible values include: 'letter', 'digit', 'whitespace', 'punctuation', 'symbol'

readonly

TokenFilterName

TokenFilterName: "arabic_normalization" | "apostrophe" | "asciifolding" | "cjk_bigram" | "cjk_width" | "classic" | "common_grams" | "edgeNGram_v2" | "elision" | "german_normalization" | "hindi_normalization" | "indic_normalization" | "keyword_repeat" | "kstem" | "length" | "limit" | "lowercase" | "nGram_v2" | "persian_normalization" | "phonetic" | "porter_stem" | "reverse" | "scandinavian_normalization" | "scandinavian_folding" | "shingle" | "snowball" | "sorani_normalization" | "stemmer" | "stopwords" | "trim" | "truncate" | "unique" | "uppercase" | "word_delimiter"

Defines values for TokenFilterName. Possible values include: 'ArabicNormalization', 'Apostrophe', 'AsciiFolding', 'CjkBigram', 'CjkWidth', 'Classic', 'CommonGram', 'EdgeNGram', 'Elision', 'GermanNormalization', 'HindiNormalization', 'IndicNormalization', 'KeywordRepeat', 'KStem', 'Length', 'Limit', 'Lowercase', 'NGram', 'PersianNormalization', 'Phonetic', 'PorterStem', 'Reverse', 'ScandinavianNormalization', 'ScandinavianFoldingNormalization', 'Shingle', 'Snowball', 'SoraniNormalization', 'Stemmer', 'Stopwords', 'Trim', 'Truncate', 'Unique', 'Uppercase', 'WordDelimiter'

readonly

TokenFilterUnion

Contains the possible cases for TokenFilter.

TokenizerName

TokenizerName: "classic" | "edgeNGram" | "keyword_v2" | "letter" | "lowercase" | "microsoft_language_tokenizer" | "microsoft_language_stemming_tokenizer" | "nGram" | "path_hierarchy_v2" | "pattern" | "standard_v2" | "uax_url_email" | "whitespace"

Defines values for TokenizerName. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'

readonly

TokenizerUnion

Contains the possible cases for Tokenizer.

VisualFeature

VisualFeature: "categories" | "tags" | "description" | "faces" | "imageType" | "color"

Defines values for VisualFeature. Possible values include: 'categories', 'tags', 'description', 'faces', 'imageType', 'color'

readonly

Variables

Const API_KEY_HEADER_NAME

API_KEY_HEADER_NAME: "api-key" = "api-key"

Const AcceptHeaderName

AcceptHeaderName: "Accept" = "Accept"

Const AcceptHeaderValue

AcceptHeaderValue: "application/json;odata.metadata=none" = "application/json;odata.metadata=none"

Const GeoJSONPointTypeName

GeoJSONPointTypeName: "Point" = "Point"

Const ISO8601DateRegex

ISO8601DateRegex: Object = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z/i

Const SDK_VERSION

SDK_VERSION: string = "11.0.0-preview.1"

Const WorldGeodeticSystem1984

WorldGeodeticSystem1984: "EPSG:4326" = "EPSG:4326"

Const logger

logger: any = createClientLogger("search")

The @azure/logger configuration for this package.

Const packageName

packageName: "@azure/search" = "@azure/search"

Const packageVersion

packageVersion: "1.0.0-preview.1" = "1.0.0-preview.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers)

Functions

deserialize

  • deserialize<OutputT>(obj: unknown): OutputT
  • Type parameters

    • OutputT

    Parameters

    • obj: unknown

    Returns OutputT

deserializeDates

  • deserializeDates(input: unknown): Date | unknown

deserializeGeoPoint

deserializeSpecialNumbers

  • deserializeSpecialNumbers(input: unknown): unknown

escapeQuotesIfString

  • escapeQuotesIfString(input: unknown, previous: string): string | unknown
  • Parameters

    • input: unknown
    • previous: string

    Returns string | unknown

isCoordinateArray

  • isCoordinateArray(maybeCoordinates: any): boolean

isCrs

  • isCrs(maybeCrs: any): boolean

isCrsProperties

  • isCrsProperties(maybeProperties: any): boolean

isGeoJSONPoint

  • isGeoJSONPoint(obj: any): obj is GeoJSONPoint

isValidObject

  • isValidObject(obj: any, options?: { propertyValidator?: undefined | ((keyName: string) => boolean); requiredKeys?: string[] }): boolean
  • Parameters

    • obj: any
    • Default value options: { propertyValidator?: undefined | ((keyName: string) => boolean); requiredKeys?: string[] } = {}
      • Optional propertyValidator?: undefined | ((keyName: string) => boolean)
      • Optional requiredKeys?: string[]

    Returns boolean

odata

  • odata(strings: TemplateStringsArray, ...values: unknown[]): string
  • Escapes an odata filter expression to avoid errors with quoting string literals. Example usage:

    const baseRateMax = 200;
    const ratingMin = 4;
    const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

    For more information on supported syntax see: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter

    Parameters

    • strings: TemplateStringsArray
    • Rest ...values: unknown[]

    Returns string

serialize

  • serialize<OutputT>(obj: unknown): OutputT
  • Type parameters

    • OutputT

    Parameters

    • obj: unknown

    Returns OutputT

serializeSpecialNumbers

  • serializeSpecialNumbers(input: unknown): unknown

walk

  • walk(start: unknown, mapper: (val: any) => any): any
  • Parameters

    • start: unknown
    • mapper: (val: any) => any
        • (val: any): any
        • Parameters

          • val: any

          Returns any

    Returns any

Object literals

Const AccessCondition

AccessCondition: object

type

type: object

className

className: string = "AccessCondition"

name

name: string = "Composite"

modelProperties

modelProperties: object

ifMatch

ifMatch: object

type

type: object

name

name: string = "String"

ifNoneMatch

ifNoneMatch: object

type

type: object

name

name: string = "String"

Const AnalyzeRequest

AnalyzeRequest: object

serializedName

serializedName: string = "AnalyzeRequest"

type

type: object

className

className: string = "AnalyzeRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

analyzer

analyzer: object

serializedName

serializedName: string = "analyzer"

type

type: object

name

name: string = "String"

charFilters

charFilters: object

serializedName

serializedName: string = "charFilters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

text

text: object

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

tokenFilters

tokenFilters: object

serializedName

serializedName: string = "tokenFilters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

tokenizer

tokenizer: object

serializedName

serializedName: string = "tokenizer"

type

type: object

name

name: string = "String"

Const AnalyzeResult

AnalyzeResult: object

serializedName

serializedName: string = "AnalyzeResult"

type

type: object

className

className: string = "AnalyzeResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

tokens

tokens: object

serializedName

serializedName: string = "tokens"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TokenInfo"

name

name: string = "Composite"

Const Analyzer

Analyzer: object

serializedName

serializedName: string = "Analyzer"

type

type: object

className

className: string = "Analyzer"

name

name: string = "Composite"

uberParent

uberParent: string = "Analyzer"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

odatatype

odatatype: object

required

required: boolean = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: string = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const AsciiFoldingTokenFilter

AsciiFoldingTokenFilter: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter"

type

type: object

className

className: string = "AsciiFoldingTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

preserveOriginal

preserveOriginal: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "preserveOriginal"

type

type: object

name

name: string = "Boolean"

Const AutocompleteItem

AutocompleteItem: object

serializedName

serializedName: string = "AutocompleteItem"

type

type: object

className

className: string = "AutocompleteItem"

name

name: string = "Composite"

modelProperties

modelProperties: object

queryPlusText

queryPlusText: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "queryPlusText"

type

type: object

name

name: string = "String"

text

text: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "text"

type

type: object

name

name: string = "String"

Const AutocompleteOptions

AutocompleteOptions: object

type

type: object

className

className: string = "AutocompleteOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

autocompleteMode

autocompleteMode: object

type

type: object

allowedValues

allowedValues: string[] = ["oneTerm","twoTerms","oneTermWithContext"]

name

name: string = "Enum"

filter

filter: object

type

type: object

name

name: string = "String"

highlightPostTag

highlightPostTag: object

type

type: object

name

name: string = "String"

highlightPreTag

highlightPreTag: object

type

type: object

name

name: string = "String"

minimumCoverage

minimumCoverage: object

type

type: object

name

name: string = "Number"

searchFields

searchFields: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

top

top: object

type

type: object

name

name: string = "Number"

useFuzzyMatching

useFuzzyMatching: object

type

type: object

name

name: string = "Boolean"

Const AutocompleteRequest

AutocompleteRequest: object

serializedName

serializedName: string = "AutocompleteRequest"

type

type: object

className

className: string = "AutocompleteRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

autocompleteMode

autocompleteMode: object

serializedName

serializedName: string = "autocompleteMode"

type

type: object

allowedValues

allowedValues: string[] = ["oneTerm","twoTerms","oneTermWithContext"]

name

name: string = "Enum"

filter

filter: object

serializedName

serializedName: string = "filter"

type

type: object

name

name: string = "String"

highlightPostTag

highlightPostTag: object

serializedName

serializedName: string = "highlightPostTag"

type

type: object

name

name: string = "String"

highlightPreTag

highlightPreTag: object

serializedName

serializedName: string = "highlightPreTag"

type

type: object

name

name: string = "String"

minimumCoverage

minimumCoverage: object

serializedName

serializedName: string = "minimumCoverage"

type

type: object

name

name: string = "Number"

searchFields

searchFields: object

serializedName

serializedName: string = "searchFields"

type

type: object

name

name: string = "String"

searchText

searchText: object

required

required: boolean = true

serializedName

serializedName: string = "search"

type

type: object

name

name: string = "String"

suggesterName

suggesterName: object

required

required: boolean = true

serializedName

serializedName: string = "suggesterName"

type

type: object

name

name: string = "String"

top

top: object

serializedName

serializedName: string = "top"

type

type: object

name

name: string = "Number"

useFuzzyMatching

useFuzzyMatching: object

serializedName

serializedName: string = "fuzzy"

type

type: object

name

name: string = "Boolean"

Const AutocompleteResult

AutocompleteResult: object

serializedName

serializedName: string = "AutocompleteResult"

type

type: object

className

className: string = "AutocompleteResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

coverage

coverage: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@search\.coverage"

type

type: object

name

name: string = "Number"

results

results: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AutocompleteItem"

name

name: string = "Composite"

Const CharFilter

CharFilter: object

serializedName

serializedName: string = "CharFilter"

type

type: object

className

className: string = "CharFilter"

name

name: string = "Composite"

uberParent

uberParent: string = "CharFilter"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

odatatype

odatatype: object

required

required: boolean = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: string = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const CjkBigramTokenFilter

CjkBigramTokenFilter: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.CjkBigramTokenFilter"

type

type: object

className

className: string = "CjkBigramTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

ignoreScripts

ignoreScripts: object

serializedName

serializedName: string = "ignoreScripts"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["han","hiragana","katakana","hangul"]

name

name: string = "Enum"

outputUnigrams

outputUnigrams: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "outputUnigrams"

type

type: object

name

name: string = "Boolean"

Const ClassicTokenizer

ClassicTokenizer: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.ClassicTokenizer"

type

type: object

className

className: string = "ClassicTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Tokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Tokenizer"

modelProperties

modelProperties: object

maxTokenLength

maxTokenLength: object

defaultValue

defaultValue: number = 255

serializedName

serializedName: string = "maxTokenLength"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

Const CognitiveServicesAccount

CognitiveServicesAccount: object

serializedName

serializedName: string = "CognitiveServicesAccount"

type

type: object

className

className: string = "CognitiveServicesAccount"

name

name: string = "Composite"

uberParent

uberParent: string = "CognitiveServicesAccount"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

odatatype

odatatype: object

required

required: boolean = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: string = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const CognitiveServicesAccountKey

CognitiveServicesAccountKey: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.CognitiveServicesByKey"

type

type: object

className

className: string = "CognitiveServicesAccountKey"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = CognitiveServicesAccount.type.polymorphicDiscriminator

uberParent

uberParent: string = "CognitiveServicesAccount"

modelProperties

modelProperties: object

key

key: object

required

required: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

Const CommonGramTokenFilter

CommonGramTokenFilter: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.CommonGramTokenFilter"

type

type: object

className

className: string = "CommonGramTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

commonWords

commonWords: object

required

required: boolean = true

serializedName

serializedName: string = "commonWords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

ignoreCase

ignoreCase: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ignoreCase"

type

type: object

name

name: string = "Boolean"

useQueryMode

useQueryMode: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "queryMode"

type

type: object

name

name: string = "Boolean"

Const ConditionalSkill

ConditionalSkill: object

serializedName

serializedName: string = "#Microsoft.Skills.Util.ConditionalSkill"

type

type: object

className

className: string = "ConditionalSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Skill.type.polymorphicDiscriminator

uberParent

uberParent: string = "Skill"

modelProperties

modelProperties: object

Const CorsOptions

CorsOptions: object

serializedName

serializedName: string = "CorsOptions"

type

type: object

className

className: string = "CorsOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

allowedOrigins

allowedOrigins: object

required

required: boolean = true

serializedName

serializedName: string = "allowedOrigins"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

maxAgeInSeconds

maxAgeInSeconds: object

serializedName

serializedName: string = "maxAgeInSeconds"

type

type: object

name

name: string = "Number"

Const CustomAnalyzer

CustomAnalyzer: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.CustomAnalyzer"

type

type: object

className

className: string = "CustomAnalyzer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Analyzer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Analyzer"

modelProperties

modelProperties: object

charFilters

charFilters: object

serializedName

serializedName: string = "charFilters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

tokenFilters

tokenFilters: object

serializedName

serializedName: string = "tokenFilters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

tokenizer

tokenizer: object

required

required: boolean = true

serializedName

serializedName: string = "tokenizer"

type

type: object

name

name: string = "String"

Const DataChangeDetectionPolicy

DataChangeDetectionPolicy: object

serializedName

serializedName: string = "DataChangeDetectionPolicy"

type

type: object

className

className: string = "DataChangeDetectionPolicy"

name

name: string = "Composite"

uberParent

uberParent: string = "DataChangeDetectionPolicy"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: boolean = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: string = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const DataContainer

DataContainer: object

serializedName

serializedName: string = "DataContainer"

type

type: object

className

className: string = "DataContainer"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

query

query: object

serializedName

serializedName: string = "query"

type

type: object

name

name: string = "String"

Const DataDeletionDetectionPolicy

DataDeletionDetectionPolicy: object

serializedName

serializedName: string = "DataDeletionDetectionPolicy"

type

type: object

className

className: string = "DataDeletionDetectionPolicy"

name

name: string = "Composite"

uberParent

uberParent: string = "DataDeletionDetectionPolicy"

modelProperties

modelProperties: object

odatatype

odatatype: object

required

required: boolean = true

serializedName

serializedName: string = "@odata\.type"

type

type: object

name

name: string = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const DataSource

DataSource: object

serializedName

serializedName: string = "DataSource"

type

type: object

className

className: string = "DataSource"

name

name: string = "Composite"

modelProperties

modelProperties: object

container

container: object

required

required: boolean = true

serializedName

serializedName: string = "container"

type

type: object

className

className: string = "DataContainer"

name

name: string = "Composite"

credentials

credentials: object

required

required: boolean = true

serializedName

serializedName: string = "credentials"

type

type: object

className

className: string = "DataSourceCredentials"

name

name: string = "Composite"

dataChangeDetectionPolicy

dataChangeDetectionPolicy: object

serializedName

serializedName: string = "dataChangeDetectionPolicy"

type

type: object

className

className: string = "DataChangeDetectionPolicy"

name

name: string = "Composite"

dataDeletionDetectionPolicy

dataDeletionDetectionPolicy: object

serializedName

serializedName: string = "dataDeletionDetectionPolicy"

type

type: object

className

className: string = "DataDeletionDetectionPolicy"

name

name: string = "Composite"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

eTag

eTag: object

serializedName

serializedName: string = "@odata\.etag"

type

type: object

name

name: string = "String"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const DataSourceCredentials

DataSourceCredentials: object

serializedName

serializedName: string = "DataSourceCredentials"

type

type: object

className

className: string = "DataSourceCredentials"

name

name: string = "Composite"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "connectionString"

type

type: object

name

name: string = "String"

Const DefaultCognitiveServicesAccount

DefaultCognitiveServicesAccount: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.DefaultCognitiveServices"

type

type: object

className

className: string = "DefaultCognitiveServicesAccount"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = CognitiveServicesAccount.type.polymorphicDiscriminator

uberParent

uberParent: string = "CognitiveServicesAccount"

modelProperties

modelProperties: object

Const DictionaryDecompounderTokenFilter

DictionaryDecompounderTokenFilter: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter"

type

type: object

className

className: string = "DictionaryDecompounderTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

maxSubwordSize

maxSubwordSize: object

defaultValue

defaultValue: number = 15

serializedName

serializedName: string = "maxSubwordSize"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

minSubwordSize

minSubwordSize: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "minSubwordSize"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

minWordSize

minWordSize: object

defaultValue

defaultValue: number = 5

serializedName

serializedName: string = "minWordSize"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

onlyLongestMatch

onlyLongestMatch: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "onlyLongestMatch"

type

type: object

name

name: string = "Boolean"

wordList

wordList: object

required

required: boolean = true

serializedName

serializedName: string = "wordList"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const DistanceScoringFunction

DistanceScoringFunction: object

serializedName

serializedName: string = "distance"

type

type: object

className

className: string = "DistanceScoringFunction"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = ScoringFunction.type.polymorphicDiscriminator

uberParent

uberParent: string = "ScoringFunction"

modelProperties

modelProperties: object

parameters

parameters: object

required

required: boolean = true

serializedName

serializedName: string = "distance"

type

type: object

className

className: string = "DistanceScoringParameters"

name

name: string = "Composite"

Const DistanceScoringParameters

DistanceScoringParameters: object

serializedName

serializedName: string = "DistanceScoringParameters"

type

type: object

className

className: string = "DistanceScoringParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

boostingDistance

boostingDistance: object

required

required: boolean = true

serializedName

serializedName: string = "boostingDistance"

type

type: object

name

name: string = "Number"

referencePointParameter

referencePointParameter: object

required

required: boolean = true

serializedName

serializedName: string = "referencePointParameter"

type

type: object

name

name: string = "String"

Const EdgeNGramTokenFilter

EdgeNGramTokenFilter: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.EdgeNGramTokenFilter"

type

type: object

className

className: string = "EdgeNGramTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

maxGram

maxGram: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "maxGram"

type

type: object

name

name: string = "Number"

minGram

minGram: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "minGram"

type

type: object

name

name: string = "Number"

side

side: object

serializedName

serializedName: string = "side"

type

type: object

allowedValues

allowedValues: string[] = ["front","back"]

name

name: string = "Enum"

Const EdgeNGramTokenFilterV2

EdgeNGramTokenFilterV2: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2"

type

type: object

className

className: string = "EdgeNGramTokenFilterV2"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

maxGram

maxGram: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "maxGram"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

minGram

minGram: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "minGram"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

side

side: object

serializedName

serializedName: string = "side"

type

type: object

allowedValues

allowedValues: string[] = ["front","back"]

name

name: string = "Enum"

Const EdgeNGramTokenizer

EdgeNGramTokenizer: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.EdgeNGramTokenizer"

type

type: object

className

className: string = "EdgeNGramTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Tokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "Tokenizer"

modelProperties

modelProperties: object

maxGram

maxGram: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "maxGram"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

minGram

minGram: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "minGram"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

tokenChars

tokenChars: object

serializedName

serializedName: string = "tokenChars"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["letter","digit","whitespace","punctuation","symbol"]

name

name: string = "Enum"

Const ElisionTokenFilter

ElisionTokenFilter: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.ElisionTokenFilter"

type

type: object

className

className: string = "ElisionTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

articles

articles: object

serializedName

serializedName: string = "articles"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const EntityRecognitionSkill

EntityRecognitionSkill: object

serializedName

serializedName: string = "#Microsoft.Skills.Text.EntityRecognitionSkill"

type

type: object

className

className: string = "EntityRecognitionSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Skill.type.polymorphicDiscriminator

uberParent

uberParent: string = "Skill"

modelProperties

modelProperties: object

categories

categories: object

serializedName

serializedName: string = "categories"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["location","organization","person","quantity","datetime","url","email"]

name

name: string = "Enum"

defaultLanguageCode

defaultLanguageCode: object

serializedName

serializedName: string = "defaultLanguageCode"

type

type: object

name

name: string = "String"

includeTypelessEntities

includeTypelessEntities: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "includeTypelessEntities"

type

type: object

name

name: string = "Boolean"

minimumPrecision

minimumPrecision: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "minimumPrecision"

type

type: object

name

name: string = "Number"

Const FacetResult

FacetResult: object

serializedName

serializedName: string = "FacetResult"

type

type: object

className

className: string = "FacetResult"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

modelProperties

modelProperties: object

count

count: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "count"

type

type: object

name

name: string = "Number"

Const Field

Field: object

serializedName

serializedName: string = "Field"

type

type: object

className

className: string = "Field"

name

name: string = "Composite"

modelProperties

modelProperties: object

analyzer

analyzer: object

serializedName

serializedName: string = "analyzer"

type

type: object

name

name: string = "String"

facetable

facetable: object

serializedName

serializedName: string = "facetable"

type

type: object

name

name: string = "Boolean"

fields

fields: object

serializedName

serializedName: string = "fields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Field"

name

name: string = "Composite"

filterable

filterable: object

serializedName

serializedName: string = "filterable"

type

type: object

name

name: string = "Boolean"

indexAnalyzer

indexAnalyzer: object

serializedName

serializedName: string = "indexAnalyzer"

type

type: object

name

name: string = "String"

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "Boolean"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

retrievable

retrievable: object

serializedName

serializedName: string = "retrievable"

type

type: object

name

name: string = "Boolean"

searchAnalyzer

searchAnalyzer: object

serializedName

serializedName: string = "searchAnalyzer"

type

type: object

name

name: string = "String"

searchable

searchable: object

serializedName

serializedName: string = "searchable"

type

type: object

name

name: string = "Boolean"

sortable

sortable: object

serializedName

serializedName: string = "sortable"

type

type: object

name

name: string = "Boolean"

synonymMaps

synonymMaps: object

serializedName

serializedName: string = "synonymMaps"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

Const FieldMapping

FieldMapping: object

serializedName

serializedName: string = "FieldMapping"

type

type: object

className

className: string = "FieldMapping"

name

name: string = "Composite"

modelProperties

modelProperties: object

mappingFunction

mappingFunction: object

serializedName

serializedName: string = "mappingFunction"

type

type: object

className

className: string = "FieldMappingFunction"

name

name: string = "Composite"

sourceFieldName

sourceFieldName: object

required

required: boolean = true

serializedName

serializedName: string = "sourceFieldName"

type

type: object

name

name: string = "String"

targetFieldName

targetFieldName: object

serializedName

serializedName: string = "targetFieldName"

type

type: object

name

name: string = "String"

Const FieldMappingFunction

FieldMappingFunction: object

serializedName

serializedName: string = "FieldMappingFunction"

type

type: object

className

className: string = "FieldMappingFunction"

name

name: string = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "Object"

Const FreshnessScoringFunction

FreshnessScoringFunction: object

serializedName

serializedName: string = "freshness"

type

type: object

className

className: string = "FreshnessScoringFunction"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = ScoringFunction.type.polymorphicDiscriminator

uberParent

uberParent: string = "ScoringFunction"

modelProperties

modelProperties: object

parameters

parameters: object

required

required: boolean = true

serializedName

serializedName: string = "freshness"

type

type: object

className

className: string = "FreshnessScoringParameters"

name

name: string = "Composite"

Const FreshnessScoringParameters

FreshnessScoringParameters: object

serializedName

serializedName: string = "FreshnessScoringParameters"

type

type: object

className

className: string = "FreshnessScoringParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

boostingDuration

boostingDuration: object

required

required: boolean = true

serializedName

serializedName: string = "boostingDuration"

type

type: object

name

name: string = "TimeSpan"

Const GetIndexStatisticsResult

GetIndexStatisticsResult: object

serializedName

serializedName: string = "GetIndexStatisticsResult"

type

type: object

className

className: string = "GetIndexStatisticsResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

documentCount

documentCount: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documentCount"

type

type: object

name

name: string = "Number"

storageSize

storageSize: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "storageSize"

type

type: object

name

name: string = "Number"

Const HighWaterMarkChangeDetectionPolicy

HighWaterMarkChangeDetectionPolicy: object

serializedName

serializedName: string = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy"

type

type: object

className

className: string = "HighWaterMarkChangeDetectionPolicy"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = DataChangeDetectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "DataChangeDetectionPolicy"

modelProperties

modelProperties: object

highWaterMarkColumnName

highWaterMarkColumnName: object

required

required: boolean = true

serializedName

serializedName: string = "highWaterMarkColumnName"

type

type: object

name

name: string = "String"

Const ImageAnalysisSkill

ImageAnalysisSkill: object

serializedName

serializedName: string = "#Microsoft.Skills.Vision.ImageAnalysisSkill"

type

type: object

className

className: string = "ImageAnalysisSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Skill.type.polymorphicDiscriminator

uberParent

uberParent: string = "Skill"

modelProperties

modelProperties: object

defaultLanguageCode

defaultLanguageCode: object

serializedName

serializedName: string = "defaultLanguageCode"

type

type: object

name

name: string = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["celebrities","landmarks"]

name

name: string = "Enum"

visualFeatures

visualFeatures: object

serializedName

serializedName: string = "visualFeatures"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["categories","tags","description","faces","imageType","color"]

name

name: string = "Enum"

Const Index

Index: object

serializedName

serializedName: string = "Index"

type

type: object

className

className: string = "Index"

name

name: string = "Composite"

modelProperties

modelProperties: object

analyzers

analyzers: object

serializedName

serializedName: string = "analyzers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Analyzer"

name

name: string = "Composite"

charFilters

charFilters: object

serializedName

serializedName: string = "charFilters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "CharFilter"

name

name: string = "Composite"

corsOptions

corsOptions: object

serializedName

serializedName: string = "corsOptions"

type

type: object

className

className: string = "CorsOptions"

name

name: string = "Composite"

defaultScoringProfile

defaultScoringProfile: object

serializedName

serializedName: string = "defaultScoringProfile"

type

type: object

name

name: string = "String"

eTag

eTag: object

serializedName

serializedName: string = "@odata\.etag"

type

type: object

name

name: string = "String"

fields

fields: object

required

required: boolean = true

serializedName

serializedName: string = "fields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Field"

name

name: string = "Composite"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

scoringProfiles

scoringProfiles: object

serializedName

serializedName: string = "scoringProfiles"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ScoringProfile"

name

name: string = "Composite"

suggesters

suggesters: object

serializedName

serializedName: string = "suggesters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Suggester"

name

name: string = "Composite"

tokenFilters

tokenFilters: object

serializedName

serializedName: string = "tokenFilters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "TokenFilter"

name

name: string = "Composite"

tokenizers

tokenizers: object

serializedName

serializedName: string = "tokenizers"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "Tokenizer"

name

name: string = "Composite"

Const IndexAction

IndexAction: object

serializedName

serializedName: string = "IndexAction"

type

type: object

className

className: string = "IndexAction"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

modelProperties

modelProperties: object

actionType

actionType: object

nullable

nullable: boolean = false

serializedName

serializedName: string = "@search\.action"

type

type: object

allowedValues

allowedValues: string[] = ["upload","merge","mergeOrUpload","delete"]

name

name: string = "Enum"

Const IndexBatch

IndexBatch: object

serializedName

serializedName: string = "IndexBatch"

type

type: object

className

className: string = "IndexBatch"

name

name: string = "Composite"

modelProperties

modelProperties: object

actions

actions: object

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "IndexAction"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

Const IndexDocumentsResult

IndexDocumentsResult: object

serializedName

serializedName: string = "IndexDocumentsResult"

type

type: object

className

className: string = "IndexDocumentsResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

results

results: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "value"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "IndexingResult"

name

name: string = "Composite"

Const Indexer

Indexer: object

serializedName

serializedName: string = "Indexer"

type

type: object

className

className: string = "Indexer"

name

name: string = "Composite"

modelProperties

modelProperties: object

dataSourceName

dataSourceName: object

required

required: boolean = true

serializedName

serializedName: string = "dataSourceName"

type

type: object

name

name: string = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

eTag

eTag: object

serializedName

serializedName: string = "@odata\.etag"

type

type: object

name

name: string = "String"

fieldMappings

fieldMappings: object

serializedName

serializedName: string = "fieldMappings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FieldMapping"

name

name: string = "Composite"

isDisabled

isDisabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "disabled"

type

type: object

name

name: string = "Boolean"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

outputFieldMappings

outputFieldMappings: object

serializedName

serializedName: string = "outputFieldMappings"

type

type: object

name

name:</