Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/search-documents

Package version

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AnalyzeTextOptions

AnalyzeTextOptions: OperationOptions & AnalyzeRequest

Options for analyze text operation.

AutocompleteMode

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

Defines values for AutocompleteMode. Possible values include: 'OneTerm', 'TwoTerms', 'OneTermWithContext'

readonly

BlobIndexerDataToExtract

BlobIndexerDataToExtract: "storageMetadata" | "allMetadata" | "contentAndMetadata"

Defines values for BlobIndexerDataToExtract. Possible values include: 'StorageMetadata', 'AllMetadata', 'ContentAndMetadata'

readonly

BlobIndexerImageAction

BlobIndexerImageAction: "none" | "generateNormalizedImages" | "generateNormalizedImagePerPage"

Defines values for BlobIndexerImageAction. Possible values include: 'None', 'GenerateNormalizedImages', 'GenerateNormalizedImagePerPage'

readonly

BlobIndexerPDFTextRotationAlgorithm

BlobIndexerPDFTextRotationAlgorithm: "none" | "detectAngles"

Defines values for BlobIndexerPDFTextRotationAlgorithm. Possible values include: 'None', 'DetectAngles'

readonly

BlobIndexerParsingMode

BlobIndexerParsingMode: "default" | "text" | "delimitedText" | "json" | "jsonArray" | "jsonLines"

Defines values for BlobIndexerParsingMode. Possible values include: 'Default', 'Text', 'DelimitedText', 'Json', 'JsonArray', 'JsonLines'

readonly

CharFilterName

CharFilterName: "html_strip"

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

readonly

CharFilterUnion

CharFilterUnion: CharFilter | MappingCharFilter | PatternReplaceCharFilter

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

CognitiveServicesAccountUnion: CognitiveServicesAccount | DefaultCognitiveServicesAccount | CognitiveServicesAccountKey

Contains the possible cases for CognitiveServicesAccount.

ComplexDataType

ComplexDataType: "Edm.ComplexType" | "Collection(Edm.ComplexType)"

Defines values for ComplexDataType. Possible values include: 'Edm.ComplexType', 'Collection(Edm.ComplexType)'

readonly

CountDocumentsOptions

CountDocumentsOptions: OperationOptions

Options for performing the count operation on the index.

CreateDataSourceConnectionOptions

CreateDataSourceConnectionOptions: OperationOptions

Options for create datasource operation.

CreateIndexOptions

CreateIndexOptions: OperationOptions

Options for create index operation.

CreateIndexerOptions

CreateIndexerOptions: OperationOptions

Options for create indexer operation.

CreateSkillsetOptions

CreateSkillsetOptions: OperationOptions

Options for create skillset operation.

CreateSynonymMapOptions

CreateSynonymMapOptions: OperationOptions

Options for create synonymmap operation.

DataChangeDetectionPolicyUnion

DataChangeDetectionPolicyUnion: DataChangeDetectionPolicy | HighWaterMarkChangeDetectionPolicy | SqlIntegratedChangeTrackingPolicy

Contains the possible cases for DataChangeDetectionPolicy.

DataDeletionDetectionPolicyUnion

DataDeletionDetectionPolicyUnion: DataDeletionDetectionPolicy | SoftDeleteColumnDeletionDetectionPolicy

Contains the possible cases for DataDeletionDetectionPolicy.

DataSourcesCreateOrUpdateResponse

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

Contains response data for the createOrUpdate operation.

DataSourcesCreateResponse

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

Contains response data for the create operation.

DataSourcesGetResponse

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

Contains response data for the get operation.

DataSourcesListResponse

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

Contains response data for the list operation.

DeleteDocumentsOptions

DeleteDocumentsOptions: IndexDocumentsOptions

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

GetDataSourceConnectionOptions

GetDataSourceConnectionOptions: OperationOptions

Options for get datasource operation.

GetIndexOptions

GetIndexOptions: OperationOptions

Options for get index operation.

GetIndexStatisticsOptions

GetIndexStatisticsOptions: OperationOptions

Options for get index statistics operation.

GetIndexerOptions

GetIndexerOptions: OperationOptions

Options for get indexer operation.

GetIndexerStatusOptions

GetIndexerStatusOptions: OperationOptions

Options for get indexer status operation.

GetServiceStatisticsOptions

GetServiceStatisticsOptions: OperationOptions

Options for get service statistics operation.

GetServiceStatisticsResponse

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

Contains response data for the getServiceStatistics operation.

GetSkillSetOptions

GetSkillSetOptions: OperationOptions

Options for get skillset operation.

GetSynonymMapsOptions

GetSynonymMapsOptions: OperationOptions

Options for get synonymmaps operation.

ImageAnalysisSkillLanguage

ImageAnalysisSkillLanguage: "en" | "es" | "ja" | "pt" | "zh"

Defines values for ImageAnalysisSkillLanguage. Possible values include: 'en', 'es', 'ja', 'pt', '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

IndexDocumentsAction

IndexDocumentsAction<T>: { __actionType: IndexActionType } & Partial<T>

Represents an index action that operates on a document.

Type parameters

  • T

IndexIterator

IndexIterator: PagedAsyncIterableIterator<SearchIndex, SearchIndex[], {}>

An iterator for listing the indexes that exist in the Search service. Will make requests as needed during iteration. Use .byPage() to make one request to the server per iteration.

IndexNameIterator

IndexNameIterator: PagedAsyncIterableIterator<string, string[], {}>

An iterator for listing the indexes that exist in the Search service. Will make requests as needed during iteration. Use .byPage() to make one request to the server per iteration.

IndexerExecutionEnvironment

IndexerExecutionEnvironment: "standard" | "private"

Defines values for IndexerExecutionEnvironment. Possible values include: 'standard', 'private'

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: SearchIndexer & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SearchIndexer } }

Contains response data for the createOrUpdate operation.

IndexersCreateResponse

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

Contains response data for the create operation.

IndexersGetResponse

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

Contains response data for the get operation.

IndexersGetStatusResponse

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

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: SearchIndex & { _response: coreHttp.HttpResponse & { bodyAsText: string; parsedBody: SearchIndex } }

Contains response data for the createOrUpdate operation.

IndexesCreateResponse

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

Contains response data for the create operation.

IndexesGetResponse

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

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

LexicalAnalyzerName

LexicalAnalyzerName: "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 LexicalAnalyzerName. Possible values include: 'ArMicrosoft', 'ArLucene', 'HyLucene', 'BnMicrosoft', 'EuLucene', 'BgMicrosoft', 'BgLucene', 'CaMicrosoft', 'CaLucene', 'ZhHansMicrosoft', 'ZhHansLucene', 'ZhHantMicrosoft', 'ZhHantLucene', 'HrMicrosoft', 'CsMicrosoft', 'CsLucene', 'DaMicrosoft', 'DaLucene', 'NlMicrosoft', 'NlLucene', 'EnMicrosoft', 'EnLucene', 'EtMicrosoft', 'FiMicrosoft', 'FiLucene', 'FrMicrosoft', 'FrLucene', 'GlLucene', 'DeMicrosoft', 'DeLucene', 'ElMicrosoft', 'ElLucene', 'GuMicrosoft', 'HeMicrosoft', 'HiMicrosoft', 'HiLucene', 'HuMicrosoft', 'HuLucene', 'IsMicrosoft', 'IdMicrosoft', 'IdLucene', 'GaLucene', 'ItMicrosoft', 'ItLucene', 'JaMicrosoft', 'JaLucene', 'KnMicrosoft', 'KoMicrosoft', 'KoLucene', 'LvMicrosoft', 'LvLucene', 'LtMicrosoft', 'MlMicrosoft', 'MsMicrosoft', 'MrMicrosoft', 'NbMicrosoft', 'NoLucene', 'FaLucene', 'PlMicrosoft', 'PlLucene', 'PtBrMicrosoft', 'PtBrLucene', 'PtPtMicrosoft', 'PtPtLucene', 'PaMicrosoft', 'RoMicrosoft', 'RoLucene', 'RuMicrosoft', 'RuLucene', 'SrCyrillicMicrosoft', 'SrLatinMicrosoft', 'SkMicrosoft', 'SlMicrosoft', 'EsMicrosoft', 'EsLucene', 'SvMicrosoft', 'SvLucene', 'TaMicrosoft', 'TeMicrosoft', 'ThMicrosoft', 'ThLucene', 'TrMicrosoft', 'TrLucene', 'UkMicrosoft', 'UrMicrosoft', 'ViMicrosoft', 'StandardLucene', 'StandardAsciiFoldingLucene', 'Keyword', 'Pattern', 'Simple', 'Stop', 'Whitespace'

readonly

LexicalAnalyzerUnion

LexicalAnalyzerUnion: LexicalAnalyzer | CustomAnalyzer | PatternAnalyzer | LuceneStandardAnalyzer | StopAnalyzer

Contains the possible cases for LexicalAnalyzer.

LexicalTokenizerName

LexicalTokenizerName: "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 LexicalTokenizerName. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'

readonly

LexicalTokenizerUnion

LexicalTokenizerUnion: LexicalTokenizer | ClassicTokenizer | EdgeNGramTokenizer | KeywordTokenizer | KeywordTokenizerV2 | MicrosoftLanguageTokenizer | MicrosoftLanguageStemmingTokenizer | NGramTokenizer | PathHierarchyTokenizerV2 | PatternTokenizer | LuceneStandardTokenizer | LuceneStandardTokenizerV2 | UaxUrlEmailTokenizer

Contains the possible cases for LexicalTokenizer.

ListDataSourceConnectionsOptions

ListDataSourceConnectionsOptions: OperationOptions

Options for a list data sources operation.

ListIndexersOptions

ListIndexersOptions: OperationOptions

Options for a list indexers operation.

ListIndexesOptions

ListIndexesOptions: OperationOptions

Options for a list indexes operation.

ListSkillsetsOptions

ListSkillsetsOptions: OperationOptions

Options for a list skillsets operation.

ListSynonymMapsOptions

ListSynonymMapsOptions: OperationOptions

Options for a list synonymMaps operation.

MergeDocumentsOptions

MergeDocumentsOptions: IndexDocumentsOptions

Options for the merge documents operation.

MergeOrUploadDocumentsOptions

MergeOrUploadDocumentsOptions: IndexDocumentsOptions

Options for the merge or upload documents operation.

MetadataLevel

MetadataLevel: "none" | "minimal"

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: 'CanonEq', 'CaseInsensitive', 'Comments', 'DotAll', 'Literal', 'Multiline', 'UnicodeCase', 'UnixLines'

readonly

ResetIndexerOptions

ResetIndexerOptions: OperationOptions

Options for reset indexer operation.

RunIndexerOptions

RunIndexerOptions: OperationOptions

Options for run indexer operation.

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

ScoringFunctionUnion: ScoringFunction | DistanceScoringFunction | FreshnessScoringFunction | MagnitudeScoringFunction | TagScoringFunction

Contains the possible cases for ScoringFunction.

ScoringStatistics

ScoringStatistics: "local" | "global"

Defines values for ScoringStatistics. Possible values include: 'Local', 'Global'

readonly

SearchClientOptions

SearchClientOptions: PipelineOptions

Client options used to configure Cognitive Search API requests.

SearchFieldDataType

SearchFieldDataType: "Edm.String" | "Edm.Int32" | "Edm.Int64" | "Edm.Double" | "Edm.Boolean" | "Edm.DateTimeOffset" | "Edm.GeographyPoint" | "Collection(Edm.String)" | "Collection(Edm.Int32)" | "Collection(Edm.Int64)" | "Collection(Edm.Double)" | "Collection(Edm.Boolean)" | "Collection(Edm.DateTimeOffset)" | "Collection(Edm.GeographyPoint)"

Defines values for SearchFieldDataType. Possible values include: 'String', 'Int32', 'Int64', 'Double', 'Boolean', 'DateTimeOffset', 'GeographyPoint', 'Complex', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.ComplexType)' Defines values for SearchFieldDataType. Possible values include: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)'

readonly
readonly

SearchIndexClientOptions

SearchIndexClientOptions: PipelineOptions

Client options used to configure Cognitive Search API requests.

SearchIndexerClientOptions

SearchIndexerClientOptions: PipelineOptions

Client options used to configure Cognitive Search API requests.

SearchIndexerDataSourceType

SearchIndexerDataSourceType: "azuresql" | "cosmosdb" | "azureblob" | "azuretable" | "mysql"

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

readonly

SearchIndexerSkillUnion

SearchIndexerSkillUnion: SearchIndexerSkill | ConditionalSkill | KeyPhraseExtractionSkill | OcrSkill | ImageAnalysisSkill | LanguageDetectionSkill | ShaperSkill | MergeSkill | EntityRecognitionSkill | SentimentSkill | SplitSkill | TextTranslationSkill | WebApiSkill

Contains the possible cases for SearchIndexerSkill.

SearchIndexingBufferedSenderDeleteDocumentsOptions

SearchIndexingBufferedSenderDeleteDocumentsOptions: OperationOptions

Options for SearchIndexingBufferedSenderDeleteDocuments.

SearchIndexingBufferedSenderFlushDocumentsOptions

SearchIndexingBufferedSenderFlushDocumentsOptions: OperationOptions

Options for SearchIndexingBufferedSenderFlushDocuments.

SearchIndexingBufferedSenderMergeDocumentsOptions

SearchIndexingBufferedSenderMergeDocumentsOptions: OperationOptions

Options for SearchIndexingBufferedSenderMergeDocuments.

SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions

SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions: OperationOptions

Options for SearchIndexingBufferedSenderMergeOrUploadDocuments.

SearchIndexingBufferedSenderUploadDocumentsOptions

SearchIndexingBufferedSenderUploadDocumentsOptions: OperationOptions

Options for SearchIndexingBufferedSenderUploadDocuments.

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

SimilarityAlgorithm

SimilarityAlgorithm: ClassicSimilarity | BM25Similarity

Contains the possible cases for Similarity.

SimilarityUnion

SimilarityUnion: Similarity | ClassicSimilarity | BM25Similarity

Contains the possible cases for Similarity.

SkillsetsCreateOrUpdateResponse

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

Contains response data for the createOrUpdate operation.

SkillsetsCreateResponse

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

Contains response data for the create operation.

SkillsetsGetResponse

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

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.

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

TokenFilterUnion: TokenFilter | AsciiFoldingTokenFilter | CjkBigramTokenFilter | CommonGramTokenFilter | DictionaryDecompounderTokenFilter | EdgeNGramTokenFilter | EdgeNGramTokenFilterV2 | ElisionTokenFilter | KeepTokenFilter | KeywordMarkerTokenFilter | LengthTokenFilter | LimitTokenFilter | NGramTokenFilter | NGramTokenFilterV2 | PatternCaptureTokenFilter | PatternReplaceTokenFilter | PhoneticTokenFilter | ShingleTokenFilter | SnowballTokenFilter | StemmerTokenFilter | StemmerOverrideTokenFilter | StopwordsTokenFilter | SynonymTokenFilter | TruncateTokenFilter | UniqueTokenFilter | WordDelimiterTokenFilter

Contains the possible cases for TokenFilter.

UploadDocumentsOptions

UploadDocumentsOptions: IndexDocumentsOptions

Options for the upload documents operation.

VisualFeature

VisualFeature: "adult" | "brands" | "categories" | "description" | "faces" | "objects" | "tags"

Defines values for VisualFeature. Possible values include: 'Adult', 'Brands', 'Categories', 'Description', 'Faces', 'Objects', 'Tags'

readonly

Variables

Const API_KEY_HEADER_NAME

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

Const AcceptHeaderName

AcceptHeaderName: "Accept" = "Accept"

Const DEFAULT_BATCH_SIZE

DEFAULT_BATCH_SIZE: number = 1000

Default Batch Size

Const DEFAULT_FLUSH_WINDOW

DEFAULT_FLUSH_WINDOW: number = 60000

Default window flush interval

Const DEFAULT_RETRY_COUNT

DEFAULT_RETRY_COUNT: number = 3

Default number of times to retry

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.1.0-beta.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-documents" = "@azure/search-documents"

Const packageVersion

packageVersion: "11.1.0-beta.1" = "11.1.0-beta.1"

Const serializer

serializer: any = new coreHttp.Serializer(Mappers)

Functions

convertAnalyzersToGenerated

convertAnalyzersToPublic

convertCognitiveServicesAccountToGenerated

convertCognitiveServicesAccountToPublic

convertDataChangeDetectionPolicyToPublic

convertDataDeletionDetectionPolicyToPublic

convertEncryptionKeyToGenerated

convertEncryptionKeyToPublic

  • convertEncryptionKeyToPublic(encryptionKey?: GeneratedSearchResourceEncryptionKey): SearchResourceEncryptionKey | undefined

  • Parameters

    • Optional encryptionKey: GeneratedSearchResourceEncryptionKey

    Returns SearchResourceEncryptionKey | undefined

convertFieldsToGenerated

  • convertFieldsToGenerated(fields: SearchField[]): GeneratedSearchField[]

convertFieldsToPublic

  • convertFieldsToPublic(fields: GeneratedSearchField[]): SearchField[]

convertSimilarityToGenerated

convertSimilarityToPublic

convertSkillsToPublic

convertTokenFiltersToGenerated

convertTokenizersToGenerated

convertTokenizersToPublic

createSearchApiKeyCredentialPolicy

  • createSearchApiKeyCredentialPolicy(credential: KeyCredential): RequestPolicyFactory

  • Create an HTTP pipeline policy to authenticate a request using an AzureKeyCredential for Azure Cognitive Search

    Parameters

    • credential: KeyCredential

    Returns RequestPolicyFactory

decode

  • decode(value: string): string

  • Decodes a base64 string into a regular string.

    Parameters

    • value: string

      The base64 string to decode.

    Returns string

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

encode

  • encode(value: string): string

  • Encodes a string in base64 format.

    Parameters

    • value: string

      The string to encode.

    Returns string

escapeQuotesIfString

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

  • Parameters

    • input: unknown
    • previous: string

    Returns string | unknown

extractOperationOptions

  • extractOperationOptions<T>(obj: T): { operationOptions: OperationOptions; restOptions: Pick<T, Exclude<keyof T, keyof OperationOptions>> }

  • Type parameters

    • T: OperationOptions

    Parameters

    • obj: T

    Returns { operationOptions: OperationOptions; restOptions: Pick<T, Exclude<keyof T, keyof OperationOptions>> }

    • operationOptions: OperationOptions
    • restOptions: Pick<T, Exclude<keyof T, keyof OperationOptions>>

formatNullAndUndefined

  • formatNullAndUndefined(input: unknown): string | unknown

  • Parameters

    • input: unknown

    Returns string | unknown

generatedDataSourceToPublicDataSource

generatedIndexToPublicIndex

  • generatedIndexToPublicIndex(generatedIndex: GeneratedSearchIndex): SearchIndex

  • Parameters

    • generatedIndex: GeneratedSearchIndex

    Returns SearchIndex

generatedSearchResultToPublicSearchResult

  • generatedSearchResultToPublicSearchResult<T>(results: GeneratedSearchResult[]): { document: T; highlights?: undefined | {}; score: number }[]

  • Type parameters

    • T

    Parameters

    • results: GeneratedSearchResult[]

    Returns { document: T; highlights?: undefined | {}; score: number }[]

generatedSkillsetToPublicSkillset

  • generatedSkillsetToPublicSkillset(generatedSkillset: GeneratedSearchIndexerSkillset): SearchIndexerSkillset

  • Parameters

    • generatedSkillset: GeneratedSearchIndexerSkillset

    Returns SearchIndexerSkillset

generatedSuggestDocumentsResultToPublicSuggestDocumentsResult

  • generatedSuggestDocumentsResultToPublicSuggestDocumentsResult<T>(searchDocumentsResult: GeneratedSuggestDocumentsResult): SuggestDocumentsResult<T>

  • Type parameters

    • T

    Parameters

    • searchDocumentsResult: GeneratedSuggestDocumentsResult

    Returns SuggestDocumentsResult<T>

generatedSynonymMapToPublicSynonymMap

  • generatedSynonymMapToPublicSynonymMap(synonymMap: GeneratedSynonymMap): SynonymMap

isComplexField

  • isComplexField(field: SearchField): field is ComplexField

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

publicIndexToGeneratedIndex

  • publicIndexToGeneratedIndex(index: SearchIndex): GeneratedSearchIndex

publicSkillsetToGeneratedSkillset

  • publicSkillsetToGeneratedSkillset(skillset: SearchIndexerSkillset): GeneratedSearchIndexerSkillset

  • Parameters

    • skillset: SearchIndexerSkillset

    Returns GeneratedSearchIndexerSkillset

publicSynonymMapToGeneratedSynonymMap

  • publicSynonymMapToGeneratedSynonymMap(synonymMap: SynonymMap): GeneratedSynonymMap

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 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

required

required: boolean = true

serializedName

serializedName: string = "tokens"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "AnalyzedTokenInfo"

name

name: string = "Composite"

Const AnalyzedTokenInfo

AnalyzedTokenInfo: object

serializedName

serializedName: string = "AnalyzedTokenInfo"

type

type: object

className

className: string = "AnalyzedTokenInfo"

name

name: string = "Composite"

modelProperties

modelProperties: object

endOffset

endOffset: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "endOffset"

type

type: object

name

name: string = "Number"

position

position: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "position"

type

type: object

name

name: string = "Number"

startOffset

startOffset: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "startOffset"

type

type: object

name

name: string = "Number"

token

token: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "token"

type

type: object

name

name: string = "String"

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 AzureActiveDirectoryApplicationCredentials

AzureActiveDirectoryApplicationCredentials: object

serializedName

serializedName: string = "AzureActiveDirectoryApplicationCredentials"

type

type: object

className

className: string = "AzureActiveDirectoryApplicationCredentials"

name

name: string = "Composite"

modelProperties

modelProperties: object

applicationId

applicationId: object

required

required: boolean = true

serializedName

serializedName: string = "applicationId"

type

type: object

name

name: string = "String"

applicationSecret

applicationSecret: object

serializedName

serializedName: string = "applicationSecret"

type

type: object

name

name: string = "String"

Const BM25Similarity

BM25Similarity: object

serializedName

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

type

type: object

className

className: string = "BM25Similarity"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Similarity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Similarity"

modelProperties

modelProperties: object

b

b: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "b"

type

type: object

name

name: string = "Number"

k1

k1: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "k1"

type

type: object

name

name: string = "Number"

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 ClassicSimilarity

ClassicSimilarity: object

serializedName

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

type

type: object

className

className: string = "ClassicSimilarity"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = Similarity.type.polymorphicDiscriminator

uberParent

uberParent: string = "Similarity"

modelProperties

modelProperties: object

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 = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

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 = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

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 = LexicalAnalyzer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalAnalyzer"

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 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 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 = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

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 = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

categories

categories: object

serializedName

serializedName: string = "categories"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

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 FieldMapping

FieldMapping: object

serializedName

serializedName: string = "FieldMapping"

type

type: object

className

className: string = "FieldMapping"

name

name: string = "Composite"

modelProperties

modelProperties: object

mappingFunction

mappingFunction: object

nullable

nullable: boolean = true

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

required

required: boolean = true

serializedName

serializedName: string = "documentCount"

type

type: object

name

name: string = "Number"

storageSize

storageSize: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: 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 = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

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

name

name: string = "String"

visualFeatures

visualFeatures: object

serializedName

serializedName: string = "visualFeatures"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

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

required

required: boolean = true

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 IndexerExecutionResult

IndexerExecutionResult: object

serializedName

serializedName: string = "IndexerExecutionResult"

type

type: object

className

className: string = "IndexerExecutionResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

nullable

nullable: boolean = true

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: string = "DateTime"

errorMessage

errorMessage: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: string = "String"

errors

errors: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SearchIndexerError"

name

name: string = "Composite"

failedItemCount

failedItemCount: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "itemsFailed"

type

type: object

name

name: string = "Number"

finalTrackingState

finalTrackingState: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "finalTrackingState"

type

type: object

name

name: string = "String"

initialTrackingState

initialTrackingState: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "initialTrackingState"

type

type: object

name

name: string = "String"

itemCount

itemCount: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "itemsProcessed"

type

type: object

name

name: string = "Number"

startTime

startTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: string = "DateTime"

status

status: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["transientFailure","success","inProgress","reset"]

name

name: string = "Enum"

warnings

warnings: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "warnings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SearchIndexerWarning"

name

name: string = "Composite"

Const IndexingParameters

IndexingParameters: object

serializedName

serializedName: string = "IndexingParameters"

type

type: object

className

className: string = "IndexingParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

batchSize

batchSize: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "batchSize"

type

type: object

name

name: string = "Number"

configuration

configuration: object

serializedName

serializedName: string = "configuration"

type

type: object

className

className: string = "IndexingParametersConfiguration"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

maxFailedItems

maxFailedItems: object

defaultValue

defaultValue: number = 0

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxFailedItems"

type

type: object

name

name: string = "Number"

maxFailedItemsPerBatch

maxFailedItemsPerBatch: object

defaultValue

defaultValue: number = 0

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxFailedItemsPerBatch"

type

type: object

name

name: string = "Number"

Const IndexingParametersConfiguration

IndexingParametersConfiguration: object

serializedName

serializedName: string = "IndexingParametersConfiguration"

type

type: object

className

className: string = "IndexingParametersConfiguration"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

modelProperties

modelProperties: object

allowSkillsetToReadFileData

allowSkillsetToReadFileData: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "allowSkillsetToReadFileData"

type

type: object

name

name: string = "Boolean"

dataToExtract

dataToExtract: object

defaultValue

defaultValue: string = "contentAndMetadata"

serializedName

serializedName: string = "dataToExtract"

type

type: object

name

name: string = "String"

delimitedTextDelimiter

delimitedTextDelimiter: object

serializedName

serializedName: string = "delimitedTextDelimiter"

type

type: object

name

name: string = "String"

delimitedTextHeaders

delimitedTextHeaders: object

serializedName

serializedName: string = "delimitedTextHeaders"

type

type: object

name

name: string = "String"

documentRoot

documentRoot: object

serializedName

serializedName: string = "documentRoot"

type

type: object

name

name: string = "String"

excludedFileNameExtensions

excludedFileNameExtensions: object

defaultValue

defaultValue: string = ""

serializedName

serializedName: string = "excludedFileNameExtensions"

type

type: object

name

name: string = "String"

executionEnvironment

executionEnvironment: object

defaultValue

defaultValue: string = "standard"

serializedName

serializedName: string = "executionEnvironment"

type

type: object

name

name: string = "String"

failOnUnprocessableDocument

failOnUnprocessableDocument: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "failOnUnprocessableDocument"

type

type: object

name

name: string = "Boolean"

failOnUnsupportedContentType

failOnUnsupportedContentType: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "failOnUnsupportedContentType"

type

type: object

name

name: string = "Boolean"

firstLineContainsHeaders

firstLineContainsHeaders: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "firstLineContainsHeaders"

type

type: object

name

name: string = "Boolean"

imageAction

imageAction: object

defaultValue

defaultValue: string = "none"

serializedName

serializedName: string = "imageAction"

type

type: object

name

name: string = "String"

indexStorageMetadataOnlyForOversizedDocuments

indexStorageMetadataOnlyForOversizedDocuments: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "indexStorageMetadataOnlyForOversizedDocuments"

type

type: object

name

name: string = "Boolean"

indexedFileNameExtensions

indexedFileNameExtensions: object

defaultValue

defaultValue: string = ""

serializedName

serializedName: string = "indexedFileNameExtensions"

type

type: object

name

name: string = "String"

parsingMode

parsingMode: object

defaultValue

defaultValue: string = "default"

serializedName

serializedName: string = "parsingMode"

type

type: object

name

name: string = "String"

pdfTextRotationAlgorithm

pdfTextRotationAlgorithm: object

defaultValue

defaultValue: string = "none"

serializedName

serializedName: string = "pdfTextRotationAlgorithm"

type

type: object

name

name: string = "String"

queryTimeout

queryTimeout: object

defaultValue

defaultValue: string = "00:05:00"

serializedName

serializedName: string = "queryTimeout"

type

type: object

name

name: string = "String"

Const IndexingResult

IndexingResult: object

serializedName

serializedName: string = "IndexingResult"

type

type: object

className

className: string = "IndexingResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

errorMessage

errorMessage: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: string = "String"

key

key: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

statusCode

statusCode: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: string = "Number"

succeeded

succeeded: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

name

name: string = "Boolean"

Const IndexingSchedule

IndexingSchedule: object

serializedName

serializedName: string = "IndexingSchedule"

type

type: object

className

className: string = "IndexingSchedule"

name

name: string = "Composite"

modelProperties

modelProperties: object

interval

interval: object

required

required: boolean = true

serializedName

serializedName: string = "interval"

type

type: object

name

name: string = "TimeSpan"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: string = "DateTime"

Const InputFieldMappingEntry

InputFieldMappingEntry: object

serializedName

serializedName: string = "InputFieldMappingEntry"

type

type: object

className

className: string = "InputFieldMappingEntry"

name

name: string = "Composite"

modelProperties

modelProperties: object

inputs

inputs: object

serializedName

serializedName: string = "inputs"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "InputFieldMappingEntry"

name

name: string = "Composite"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

source

source: object

serializedName

serializedName: string = "source"

type

type: object

name

name: string = "String"

sourceContext

sourceContext: object

serializedName

serializedName: string = "sourceContext"

type

type: object

name

name: string = "String"

Const KeepTokenFilter

KeepTokenFilter: object

serializedName

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

type

type: object

className

className: string = "KeepTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

keepWords

keepWords: object

required

required: boolean = true

serializedName

serializedName: string = "keepWords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

lowerCaseKeepWords

lowerCaseKeepWords: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "keepWordsCase"

type

type: object

name

name: string = "Boolean"

Const KeyPhraseExtractionSkill

KeyPhraseExtractionSkill: object

serializedName

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

type

type: object

className

className: string = "KeyPhraseExtractionSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

defaultLanguageCode

defaultLanguageCode: object

serializedName

serializedName: string = "defaultLanguageCode"

type

type: object

name

name: string = "String"

maxKeyPhraseCount

maxKeyPhraseCount: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxKeyPhraseCount"

type

type: object

name

name: string = "Number"

Const KeywordMarkerTokenFilter

KeywordMarkerTokenFilter: object

serializedName

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

type

type: object

className

className: string = "KeywordMarkerTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

ignoreCase

ignoreCase: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ignoreCase"

type

type: object

name

name: string = "Boolean"

keywords

keywords: object

required

required: boolean = true

serializedName

serializedName: string = "keywords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const KeywordTokenizer

KeywordTokenizer: object

serializedName

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

type

type: object

className

className: string = "KeywordTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

bufferSize

bufferSize: object

defaultValue

defaultValue: number = 256

serializedName

serializedName: string = "bufferSize"

type

type: object

name

name: string = "Number"

Const KeywordTokenizerV2

KeywordTokenizerV2: object

serializedName

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

type

type: object

className

className: string = "KeywordTokenizerV2"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

maxTokenLength

maxTokenLength: object

defaultValue

defaultValue: number = 256

serializedName

serializedName: string = "maxTokenLength"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

Const LanguageDetectionSkill

LanguageDetectionSkill: object

serializedName

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

type

type: object

className

className: string = "LanguageDetectionSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

Const LengthTokenFilter

LengthTokenFilter: object

serializedName

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

type

type: object

className

className: string = "LengthTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

maxLength

maxLength: object

defaultValue

defaultValue: number = 300

serializedName

serializedName: string = "max"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

minLength

minLength: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "min"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

Const LexicalAnalyzer

LexicalAnalyzer: object

serializedName

serializedName: string = "LexicalAnalyzer"

type

type: object

className

className: string = "LexicalAnalyzer"

name

name: string = "Composite"

uberParent

uberParent: string = "LexicalAnalyzer"

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 LexicalTokenizer

LexicalTokenizer: object

serializedName

serializedName: string = "LexicalTokenizer"

type

type: object

className

className: string = "LexicalTokenizer"

name

name: string = "Composite"

uberParent

uberParent: string = "LexicalTokenizer"

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 LimitTokenFilter

LimitTokenFilter: object

serializedName

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

type

type: object

className

className: string = "LimitTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

consumeAllTokens

consumeAllTokens: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "consumeAllTokens"

type

type: object

name

name: string = "Boolean"

maxTokenCount

maxTokenCount: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "maxTokenCount"

type

type: object

name

name: string = "Number"

Const ListDataSourcesResult

ListDataSourcesResult: object

serializedName

serializedName: string = "ListDataSourcesResult"

type

type: object

className

className: string = "ListDataSourcesResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

dataSources

dataSources: 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 = "SearchIndexerDataSource"

name

name: string = "Composite"

Const ListIndexersResult

ListIndexersResult: object

serializedName

serializedName: string = "ListIndexersResult"

type

type: object

className

className: string = "ListIndexersResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

indexers

indexers: 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 = "SearchIndexer"

name

name: string = "Composite"

Const ListIndexesResult

ListIndexesResult: object

serializedName

serializedName: string = "ListIndexesResult"

type

type: object

className

className: string = "ListIndexesResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

indexes

indexes: 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 = "SearchIndex"

name

name: string = "Composite"

Const ListSkillsetsResult

ListSkillsetsResult: object

serializedName

serializedName: string = "ListSkillsetsResult"

type

type: object

className

className: string = "ListSkillsetsResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

skillsets

skillsets: 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 = "SearchIndexerSkillset"

name

name: string = "Composite"

Const ListSynonymMapsResult

ListSynonymMapsResult: object

serializedName

serializedName: string = "ListSynonymMapsResult"

type

type: object

className

className: string = "ListSynonymMapsResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

synonymMaps

synonymMaps: 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 = "SynonymMap"

name

name: string = "Composite"

Const LuceneStandardAnalyzer

LuceneStandardAnalyzer: object

serializedName

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

type

type: object

className

className: string = "LuceneStandardAnalyzer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalAnalyzer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalAnalyzer"

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"

stopwords

stopwords: object

serializedName

serializedName: string = "stopwords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const LuceneStandardTokenizer

LuceneStandardTokenizer: object

serializedName

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

type

type: object

className

className: string = "LuceneStandardTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

maxTokenLength

maxTokenLength: object

defaultValue

defaultValue: number = 255

serializedName

serializedName: string = "maxTokenLength"

type

type: object

name

name: string = "Number"

Const LuceneStandardTokenizerV2

LuceneStandardTokenizerV2: object

serializedName

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

type

type: object

className

className: string = "LuceneStandardTokenizerV2"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

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 MagnitudeScoringFunction

MagnitudeScoringFunction: object

serializedName

serializedName: string = "magnitude"

type

type: object

className

className: string = "MagnitudeScoringFunction"

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 = "magnitude"

type

type: object

className

className: string = "MagnitudeScoringParameters"

name

name: string = "Composite"

Const MagnitudeScoringParameters

MagnitudeScoringParameters: object

serializedName

serializedName: string = "MagnitudeScoringParameters"

type

type: object

className

className: string = "MagnitudeScoringParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

boostingRangeEnd

boostingRangeEnd: object

required

required: boolean = true

serializedName

serializedName: string = "boostingRangeEnd"

type

type: object

name

name: string = "Number"

boostingRangeStart

boostingRangeStart: object

required

required: boolean = true

serializedName

serializedName: string = "boostingRangeStart"

type

type: object

name

name: string = "Number"

shouldBoostBeyondRangeByConstant

shouldBoostBeyondRangeByConstant: object

serializedName

serializedName: string = "constantBoostBeyondRange"

type

type: object

name

name: string = "Boolean"

Const MappingCharFilter

MappingCharFilter: object

serializedName

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

type

type: object

className

className: string = "MappingCharFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = CharFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "CharFilter"

modelProperties

modelProperties: object

mappings

mappings: object

required

required: boolean = true

serializedName

serializedName: string = "mappings"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const MergeSkill

MergeSkill: object

serializedName

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

type

type: object

className

className: string = "MergeSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

insertPostTag

insertPostTag: object

defaultValue

defaultValue: string = ""

serializedName

serializedName: string = "insertPostTag"

type

type: object

name

name: string = "String"

insertPreTag

insertPreTag: object

defaultValue

defaultValue: string = ""

serializedName

serializedName: string = "insertPreTag"

type

type: object

name

name: string = "String"

Const MicrosoftLanguageStemmingTokenizer

MicrosoftLanguageStemmingTokenizer: object

serializedName

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

type

type: object

className

className: string = "MicrosoftLanguageStemmingTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

isSearchTokenizer

isSearchTokenizer: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "isSearchTokenizer"

type

type: object

name

name: string = "Boolean"

language

language: object

serializedName

serializedName: string = "language"

type

type: object

allowedValues

allowedValues: string[] = ["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"]

name

name: string = "Enum"

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 MicrosoftLanguageTokenizer

MicrosoftLanguageTokenizer: object

serializedName

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

type

type: object

className

className: string = "MicrosoftLanguageTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

isSearchTokenizer

isSearchTokenizer: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "isSearchTokenizer"

type

type: object

name

name: string = "Boolean"

language

language: object

serializedName

serializedName: string = "language"

type

type: object

allowedValues

allowedValues: string[] = ["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"]

name

name: string = "Enum"

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 NGramTokenFilter

NGramTokenFilter: object

serializedName

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

type

type: object

className

className: string = "NGramTokenFilter"

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"

Const NGramTokenFilterV2

NGramTokenFilterV2: object

serializedName

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

type

type: object

className

className: string = "NGramTokenFilterV2"

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"

Const NGramTokenizer

NGramTokenizer: object

serializedName

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

type

type: object

className

className: string = "NGramTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

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 OcrSkill

OcrSkill: object

serializedName

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

type

type: object

className

className: string = "OcrSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

defaultLanguageCode

defaultLanguageCode: object

serializedName

serializedName: string = "defaultLanguageCode"

type

type: object

name

name: string = "String"

shouldDetectOrientation

shouldDetectOrientation: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "detectOrientation"

type

type: object

name

name: string = "Boolean"

Const OutputFieldMappingEntry

OutputFieldMappingEntry: object

serializedName

serializedName: string = "OutputFieldMappingEntry"

type

type: object

className

className: string = "OutputFieldMappingEntry"

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"

targetName

targetName: object

serializedName

serializedName: string = "targetName"

type

type: object

name

name: string = "String"

Const PathHierarchyTokenizerV2

PathHierarchyTokenizerV2: object

serializedName

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

type

type: object

className

className: string = "PathHierarchyTokenizerV2"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

delimiter

delimiter: object

defaultValue

defaultValue: string = "/"

serializedName

serializedName: string = "delimiter"

type

type: object

name

name: string = "String"

maxTokenLength

maxTokenLength: object

defaultValue

defaultValue: number = 300

serializedName

serializedName: string = "maxTokenLength"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

numberOfTokensToSkip

numberOfTokensToSkip: object

defaultValue

defaultValue: number = 0

serializedName

serializedName: string = "skip"

type

type: object

name

name: string = "Number"

replacement

replacement: object

defaultValue

defaultValue: string = "/"

serializedName

serializedName: string = "replacement"

type

type: object

name

name: string = "String"

reverseTokenOrder

reverseTokenOrder: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "reverse"

type

type: object

name

name: string = "Boolean"

Const PatternAnalyzer

PatternAnalyzer: object

serializedName

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

type

type: object

className

className: string = "PatternAnalyzer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalAnalyzer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalAnalyzer"

modelProperties

modelProperties: object

flags

flags: object

serializedName

serializedName: string = "flags"

type

type: object

name

name: string = "String"

lowerCaseTerms

lowerCaseTerms: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "lowercase"

type

type: object

name

name: string = "Boolean"

pattern

pattern: object

defaultValue

defaultValue: string = "W+"

serializedName

serializedName: string = "pattern"

type

type: object

name

name: string = "String"

stopwords

stopwords: object

serializedName

serializedName: string = "stopwords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const PatternCaptureTokenFilter

PatternCaptureTokenFilter: object

serializedName

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

type

type: object

className

className: string = "PatternCaptureTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

patterns

patterns: object

required

required: boolean = true

serializedName

serializedName: string = "patterns"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

preserveOriginal

preserveOriginal: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "preserveOriginal"

type

type: object

name

name: string = "Boolean"

Const PatternReplaceCharFilter

PatternReplaceCharFilter: object

serializedName

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

type

type: object

className

className: string = "PatternReplaceCharFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = CharFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "CharFilter"

modelProperties

modelProperties: object

pattern

pattern: object

required

required: boolean = true

serializedName

serializedName: string = "pattern"

type

type: object

name

name: string = "String"

replacement

replacement: object

required

required: boolean = true

serializedName

serializedName: string = "replacement"

type

type: object

name

name: string = "String"

Const PatternReplaceTokenFilter

PatternReplaceTokenFilter: object

serializedName

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

type

type: object

className

className: string = "PatternReplaceTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

pattern

pattern: object

required

required: boolean = true

serializedName

serializedName: string = "pattern"

type

type: object

name

name: string = "String"

replacement

replacement: object

required

required: boolean = true

serializedName

serializedName: string = "replacement"

type

type: object

name

name: string = "String"

Const PatternTokenizer

PatternTokenizer: object

serializedName

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

type

type: object

className

className: string = "PatternTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

modelProperties

modelProperties: object

flags

flags: object

serializedName

serializedName: string = "flags"

type

type: object

name

name: string = "String"

group

group: object

defaultValue

defaultValue: number = -1

serializedName

serializedName: string = "group"

type

type: object

name

name: string = "Number"

pattern

pattern: object

defaultValue

defaultValue: string = "W+"

serializedName

serializedName: string = "pattern"

type

type: object

name

name: string = "String"

Const PhoneticTokenFilter

PhoneticTokenFilter: object

serializedName

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

type

type: object

className

className: string = "PhoneticTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

encoder

encoder: object

serializedName

serializedName: string = "encoder"

type

type: object

allowedValues

allowedValues: string[] = ["metaphone","doubleMetaphone","soundex","refinedSoundex","caverphone1","caverphone2","cologne","nysiis","koelnerPhonetik","haasePhonetik","beiderMorse"]

name

name: string = "Enum"

replaceOriginalTokens

replaceOriginalTokens: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "replace"

type

type: object

name

name: string = "Boolean"

Const ResourceCounter

ResourceCounter: object

serializedName

serializedName: string = "ResourceCounter"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

modelProperties

modelProperties: object

quota

quota: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "quota"

type

type: object

name

name: string = "Number"

usage

usage: object

nullable

nullable: boolean = false

required

required: boolean = true

serializedName

serializedName: string = "usage"

type

type: object

name

name: string = "Number"

Const ScoringFunction

ScoringFunction: object

serializedName

serializedName: string = "ScoringFunction"

type

type: object

className

className: string = "ScoringFunction"

name

name: string = "Composite"

uberParent

uberParent: string = "ScoringFunction"

modelProperties

modelProperties: object

boost

boost: object

required

required: boolean = true

serializedName

serializedName: string = "boost"

type

type: object

name

name: string = "Number"

fieldName

fieldName: object

required

required: boolean = true

serializedName

serializedName: string = "fieldName"

type

type: object

name

name: string = "String"

interpolation

interpolation: object

serializedName

serializedName: string = "interpolation"

type

type: object

allowedValues

allowedValues: string[] = ["linear","constant","quadratic","logarithmic"]

name

name: string = "Enum"

type

type: object

required

required: boolean = true

serializedName

serializedName: string = "type"

type

type: object

name

name: string = "String"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "type"

serializedName

serializedName: string = "type"

Const ScoringProfile

ScoringProfile: object

serializedName

serializedName: string = "ScoringProfile"

type

type: object

className

className: string = "ScoringProfile"

name

name: string = "Composite"

modelProperties

modelProperties: object

functionAggregation

functionAggregation: object

serializedName

serializedName: string = "functionAggregation"

type

type: object

allowedValues

allowedValues: string[] = ["sum","average","minimum","maximum","firstMatching"]

name

name: string = "Enum"

functions

functions: object

serializedName

serializedName: string = "functions"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "ScoringFunction"

name

name: string = "Composite"

name

name: object

required

required: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

textWeights

textWeights: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "text"

type

type: object

className

className: string = "TextWeights"

name

name: string = "Composite"

Const SearchDocumentsResult

SearchDocumentsResult: object

serializedName

serializedName: string = "SearchDocumentsResult"

type

type: object

className

className: string = "SearchDocumentsResult"

name

name: string = "Composite"

modelProperties

modelProperties: object

count

count: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@odata\.count"

type

type: object

name

name: string = "Number"

coverage

coverage: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@search\.coverage"

type

type: object

name

name: string = "Number"

facets

facets: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@search\.facets"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FacetResult"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@odata\.nextLink"

type

type: object

name

name: string = "String"

nextPageParameters

nextPageParameters: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@search\.nextPageParameters"

type

type: object

className

className: string = "SearchRequest"

name

name: string = "Composite"

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 = "SearchResult"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

Const SearchError

SearchError: object

serializedName

serializedName: string = "SearchError"

type

type: object

className

className: string = "SearchError"

name

name: string = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "code"

type

type: object

name

name: string = "String"

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SearchError"

name

name: string = "Composite"

message

message: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

Const SearchField

SearchField: object

serializedName

serializedName: string = "SearchField"

type

type: object

className

className: string = "SearchField"

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 = "SearchField"

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 SearchIndex

SearchIndex: object

serializedName

serializedName: string = "SearchIndex"

type

type: object

className

className: string = "SearchIndex"

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 = "LexicalAnalyzer"

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

nullable

nullable: boolean = true

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"

encryptionKey

encryptionKey: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "encryptionKey"

type

type: object

className

className: string = "SearchResourceEncryptionKey"

name

name: string = "Composite"

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 = "SearchField"

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"

similarity

similarity: object

serializedName

serializedName: string = "similarity"

type

type: object

className

className: string = "Similarity"

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 = "LexicalTokenizer"

name

name: string = "Composite"

Const SearchIndexer

SearchIndexer: object

serializedName

serializedName: string = "SearchIndexer"

type

type: object

className

className: string = "SearchIndexer"

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

nullable

nullable: boolean = true

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: string = "Sequence"

element

element: object

type

type: object

className

className: string = "FieldMapping"

name

name: string = "Composite"

parameters

parameters: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "parameters"

type

type: object

className

className: string = "IndexingParameters"

name

name: string = "Composite"

schedule

schedule: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "IndexingSchedule"

name

name: string = "Composite"

skillsetName

skillsetName: object

serializedName

serializedName: string = "skillsetName"

type

type: object

name

name: string = "String"

targetIndexName

targetIndexName: object

required

required: boolean = true

serializedName

serializedName: string = "targetIndexName"

type

type: object

name

name: string = "String"

Const SearchIndexerDataContainer

SearchIndexerDataContainer: object

serializedName

serializedName: string = "SearchIndexerDataContainer"

type

type: object

className

className: string = "SearchIndexerDataContainer"

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 SearchIndexerDataSource

SearchIndexerDataSource: object

serializedName

serializedName: string = "SearchIndexerDataSource"

type

type: object

className

className: string = "SearchIndexerDataSource"

name

name: string = "Composite"

modelProperties

modelProperties: object

container

container: object

required

required: boolean = true

serializedName

serializedName: string = "container"

type

type: object

className

className: string = "SearchIndexerDataContainer"

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

nullable

nullable: boolean = true

serializedName

serializedName: string = "dataChangeDetectionPolicy"

type

type: object

className

className: string = "DataChangeDetectionPolicy"

name

name: string = "Composite"

dataDeletionDetectionPolicy

dataDeletionDetectionPolicy: object

nullable

nullable: boolean = true

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 SearchIndexerError

SearchIndexerError: object

serializedName

serializedName: string = "SearchIndexerError"

type

type: object

className

className: string = "SearchIndexerError"

name

name: string = "Composite"

modelProperties

modelProperties: object

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "String"

documentationLink

documentationLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documentationLink"

type

type: object

name

name: string = "String"

errorMessage

errorMessage: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "errorMessage"

type

type: object

name

name: string = "String"

key

key: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

statusCode

statusCode: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: string = "Number"

Const SearchIndexerLimits

SearchIndexerLimits: object

serializedName

serializedName: string = "SearchIndexerLimits"

type

type: object

className

className: string = "SearchIndexerLimits"

name

name: string = "Composite"

modelProperties

modelProperties: object

maxDocumentContentCharactersToExtract

maxDocumentContentCharactersToExtract: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "maxDocumentContentCharactersToExtract"

type

type: object

name

name: string = "Number"

maxDocumentExtractionSize

maxDocumentExtractionSize: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "maxDocumentExtractionSize"

type

type: object

name

name: string = "Number"

maxRunTime

maxRunTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "maxRunTime"

type

type: object

name

name: string = "TimeSpan"

Const SearchIndexerSkill

SearchIndexerSkill: object

serializedName

serializedName: string = "SearchIndexerSkill"

type

type: object

className

className: string = "SearchIndexerSkill"

name

name: string = "Composite"

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

context

context: object

serializedName

serializedName: string = "context"

type

type: object

name

name: string = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: string = "String"

inputs

inputs: object

required

required: boolean = true

serializedName

serializedName: string = "inputs"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "InputFieldMappingEntry"

name

name: string = "Composite"

name

name: object

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"

outputs

outputs: object

required

required: boolean = true

serializedName

serializedName: string = "outputs"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "OutputFieldMappingEntry"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: object

clientName

clientName: string = "odatatype"

serializedName

serializedName: string = "@odata.type"

Const SearchIndexerSkillset

SearchIndexerSkillset: object

serializedName

serializedName: string = "SearchIndexerSkillset"

type

type: object

className

className: string = "SearchIndexerSkillset"

name

name: string = "Composite"

modelProperties

modelProperties: object

cognitiveServicesAccount

cognitiveServicesAccount: object

serializedName

serializedName: string = "cognitiveServices"

type

type: object

className

className: string = "CognitiveServicesAccount"

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"

skills

skills: object

required

required: boolean = true

serializedName

serializedName: string = "skills"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "SearchIndexerSkill"

name

name: string = "Composite"

Const SearchIndexerStatus

SearchIndexerStatus: object

serializedName

serializedName: string = "SearchIndexerStatus"

type

type: object

className

className: string = "SearchIndexerStatus"

name

name: string = "Composite"

modelProperties

modelProperties: object

executionHistory

executionHistory: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "executionHistory"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

className

className: string = "IndexerExecutionResult"

name

name: string = "Composite"

lastResult

lastResult: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "lastResult"

type

type: object

className

className: string = "IndexerExecutionResult"

name

name: string = "Composite"

limits

limits: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "limits"

type

type: object

className

className: string = "SearchIndexerLimits"

name

name: string = "Composite"

status

status: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["unknown","error","running"]

name

name: string = "Enum"

Const SearchIndexerWarning

SearchIndexerWarning: object

serializedName

serializedName: string = "SearchIndexerWarning"

type

type: object

className

className: string = "SearchIndexerWarning"

name

name: string = "Composite"

modelProperties

modelProperties: object

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

name

name: string = "String"

documentationLink

documentationLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "documentationLink"

type

type: object

name

name: string = "String"

key

key: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

message

message: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "message"

type

type: object

name

name: string = "String"

name

name: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

name: string = "String"

Const SearchOptions

SearchOptions: object

type

type: object

className

className: string = "SearchOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

facets

facets: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

filter

filter: object

type

type: object

name

name: string = "String"

highlightFields

highlightFields: object

type

type: object

name

name: string = "Sequence"

element

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

includeTotalResultCount

includeTotalResultCount: object

type

type: object

name

name: string = "Boolean"

minimumCoverage

minimumCoverage: object

type

type: object

name

name: string = "Number"

orderBy

orderBy: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

queryType

queryType: object

type

type: object

allowedValues

allowedValues: string[] = ["simple","full"]

name

name: string = "Enum"

scoringParameters

scoringParameters: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

scoringProfile

scoringProfile: object

type

type: object

name

name: string = "String"

scoringStatistics

scoringStatistics: object

type

type: object

allowedValues

allowedValues: string[] = ["local","global"]

name

name: string = "Enum"

searchFields

searchFields: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

searchMode

searchMode: object

type

type: object

allowedValues

allowedValues: string[] = ["any","all"]

name

name: string = "Enum"

select

select: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

sessionId

sessionId: object

type

type: object

name

name: string = "String"

skip

skip: object

type

type: object

name

name: string = "Number"

top

top: object

type

type: object

name

name: string = "Number"

Const SearchRequest

SearchRequest: object

serializedName

serializedName: string = "SearchRequest"

type

type: object

className

className: string = "SearchRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

facets

facets: object

serializedName

serializedName: string = "facets"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

filter

filter: object

serializedName

serializedName: string = "filter"

type

type: object

name

name: string = "String"

highlightFields

highlightFields: object

serializedName

serializedName: string = "highlight"

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"

includeTotalResultCount

includeTotalResultCount: object

serializedName

serializedName: string = "count"

type

type: object

name

name: string = "Boolean"

minimumCoverage

minimumCoverage: object

serializedName

serializedName: string = "minimumCoverage"

type

type: object

name

name: string = "Number"

orderBy

orderBy: object

serializedName

serializedName: string = "orderby"

type

type: object

name

name: string = "String"

queryType

queryType: object

serializedName

serializedName: string = "queryType"

type

type: object

allowedValues

allowedValues: string[] = ["simple","full"]

name

name: string = "Enum"

scoringParameters

scoringParameters: object

serializedName

serializedName: string = "scoringParameters"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

scoringProfile

scoringProfile: object

serializedName

serializedName: string = "scoringProfile"

type

type: object

name

name: string = "String"

scoringStatistics

scoringStatistics: object

serializedName

serializedName: string = "scoringStatistics"

type

type: object

allowedValues

allowedValues: string[] = ["local","global"]

name

name: string = "Enum"

searchFields

searchFields: object

serializedName

serializedName: string = "searchFields"

type

type: object

name

name: string = "String"

searchMode

searchMode: object

serializedName

serializedName: string = "searchMode"

type

type: object

allowedValues

allowedValues: string[] = ["any","all"]

name

name: string = "Enum"

searchText

searchText: object

serializedName

serializedName: string = "search"

type

type: object

name

name: string = "String"

select

select: object

serializedName

serializedName: string = "select"

type

type: object

name

name: string = "String"

sessionId

sessionId: object

serializedName

serializedName: string = "sessionId"

type

type: object

name

name: string = "String"

skip

skip: object

serializedName

serializedName: string = "skip"

type

type: object

name

name: string = "Number"

top

top: object

serializedName

serializedName: string = "top"

type

type: object

name

name: string = "Number"

Const SearchResourceEncryptionKey

SearchResourceEncryptionKey: object

serializedName

serializedName: string = "SearchResourceEncryptionKey"

type

type: object

className

className: string = "SearchResourceEncryptionKey"

name

name: string = "Composite"

modelProperties

modelProperties: object

accessCredentials

accessCredentials: object

serializedName

serializedName: string = "accessCredentials"

type

type: object

className

className: string = "AzureActiveDirectoryApplicationCredentials"

name

name: string = "Composite"

keyName

keyName: object

required

required: boolean = true

serializedName

serializedName: string = "keyVaultKeyName"

type

type: object

name

name: string = "String"

keyVersion

keyVersion: object

required

required: boolean = true

serializedName

serializedName: string = "keyVaultKeyVersion"

type

type: object

name

name: string = "String"

vaultUri

vaultUri: object

required

required: boolean = true

serializedName

serializedName: string = "keyVaultUri"

type

type: object

name

name: string = "String"

Const SearchResult

SearchResult: object

serializedName

serializedName: string = "SearchResult"

type

type: object

className

className: string = "SearchResult"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

modelProperties

modelProperties: object

_highlights

_highlights: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "@search\.highlights"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

_score

_score: object

nullable

nullable: boolean = false

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "@search\.score"

type

type: object

name

name: string = "Number"

Const SentimentSkill

SentimentSkill: object

serializedName

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

type

type: object

className

className: string = "SentimentSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

defaultLanguageCode

defaultLanguageCode: object

serializedName

serializedName: string = "defaultLanguageCode"

type

type: object

name

name: string = "String"

Const ServiceCounters

ServiceCounters: object

serializedName

serializedName: string = "ServiceCounters"

type

type: object

className

className: string = "ServiceCounters"

name

name: string = "Composite"

modelProperties

modelProperties: object

dataSourceCounter

dataSourceCounter: object

required

required: boolean = true

serializedName

serializedName: string = "dataSourcesCount"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

documentCounter

documentCounter: object

required

required: boolean = true

serializedName

serializedName: string = "documentCount"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

indexCounter

indexCounter: object

required

required: boolean = true

serializedName

serializedName: string = "indexesCount"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

indexerCounter

indexerCounter: object

required

required: boolean = true

serializedName

serializedName: string = "indexersCount"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

storageSizeCounter

storageSizeCounter: object

required

required: boolean = true

serializedName

serializedName: string = "storageSize"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

synonymMapCounter

synonymMapCounter: object

required

required: boolean = true

serializedName

serializedName: string = "synonymMaps"

type

type: object

className

className: string = "ResourceCounter"

name

name: string = "Composite"

Const ServiceLimits

ServiceLimits: object

serializedName

serializedName: string = "ServiceLimits"

type

type: object

className

className: string = "ServiceLimits"

name

name: string = "Composite"

modelProperties

modelProperties: object

maxComplexCollectionFieldsPerIndex

maxComplexCollectionFieldsPerIndex: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxComplexCollectionFieldsPerIndex"

type

type: object

name

name: string = "Number"

maxComplexObjectsInCollectionsPerDocument

maxComplexObjectsInCollectionsPerDocument: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxComplexObjectsInCollectionsPerDocument"

type

type: object

name

name: string = "Number"

maxFieldNestingDepthPerIndex

maxFieldNestingDepthPerIndex: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxFieldNestingDepthPerIndex"

type

type: object

name

name: string = "Number"

maxFieldsPerIndex

maxFieldsPerIndex: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "maxFieldsPerIndex"

type

type: object

name

name: string = "Number"

Const ServiceStatistics

ServiceStatistics: object

serializedName

serializedName: string = "ServiceStatistics"

type

type: object

className

className: string = "ServiceStatistics"

name

name: string = "Composite"

modelProperties

modelProperties: object

counters

counters: object

required

required: boolean = true

serializedName

serializedName: string = "counters"

type

type: object

className

className: string = "ServiceCounters"

name

name: string = "Composite"

limits

limits: object

required

required: boolean = true

serializedName

serializedName: string = "limits"

type

type: object

className

className: string = "ServiceLimits"

name

name: string = "Composite"

Const ShaperSkill

ShaperSkill: object

serializedName

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

type

type: object

className

className: string = "ShaperSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

Const ShingleTokenFilter

ShingleTokenFilter: object

serializedName

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

type

type: object

className

className: string = "ShingleTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

filterToken

filterToken: object

defaultValue

defaultValue: string = "_"

serializedName

serializedName: string = "filterToken"

type

type: object

name

name: string = "String"

maxShingleSize

maxShingleSize: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "maxShingleSize"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 2

type

type: object

name

name: string = "Number"

minShingleSize

minShingleSize: object

defaultValue

defaultValue: number = 2

serializedName

serializedName: string = "minShingleSize"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 2

type

type: object

name

name: string = "Number"

outputUnigrams

outputUnigrams: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "outputUnigrams"

type

type: object

name

name: string = "Boolean"

outputUnigramsIfNoShingles

outputUnigramsIfNoShingles: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "outputUnigramsIfNoShingles"

type

type: object

name

name: string = "Boolean"

tokenSeparator

tokenSeparator: object

defaultValue

defaultValue: string = ""

serializedName

serializedName: string = "tokenSeparator"

type

type: object

name

name: string = "String"

Const Similarity

Similarity: object

serializedName

serializedName: string = "Similarity"

type

type: object

className

className: string = "Similarity"

name

name: string = "Composite"

uberParent

uberParent: string = "Similarity"

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 SnowballTokenFilter

SnowballTokenFilter: object

serializedName

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

type

type: object

className

className: string = "SnowballTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

language

language: object

required

required: boolean = true

serializedName

serializedName: string = "language"

type

type: object

allowedValues

allowedValues: string[] = ["armenian","basque","catalan","danish","dutch","english","finnish","french","german","german2","hungarian","italian","kp","lovins","norwegian","porter","portuguese","romanian","russian","spanish","swedish","turkish"]

name

name: string = "Enum"

Const SoftDeleteColumnDeletionDetectionPolicy

SoftDeleteColumnDeletionDetectionPolicy: object

serializedName

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

type

type: object

className

className: string = "SoftDeleteColumnDeletionDetectionPolicy"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = DataDeletionDetectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "DataDeletionDetectionPolicy"

modelProperties

modelProperties: object

softDeleteColumnName

softDeleteColumnName: object

serializedName

serializedName: string = "softDeleteColumnName"

type

type: object

name

name: string = "String"

softDeleteMarkerValue

softDeleteMarkerValue: object

serializedName

serializedName: string = "softDeleteMarkerValue"

type

type: object

name

name: string = "String"

Const SplitSkill

SplitSkill: object

serializedName

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

type

type: object

className

className: string = "SplitSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

defaultLanguageCode

defaultLanguageCode: object

serializedName

serializedName: string = "defaultLanguageCode"

type

type: object

name

name: string = "String"

maxPageLength

maxPageLength: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "maximumPageLength"

type

type: object

name

name: string = "Number"

textSplitMode

textSplitMode: object

serializedName

serializedName: string = "textSplitMode"

type

type: object

name

name: string = "String"

Const SqlIntegratedChangeTrackingPolicy

SqlIntegratedChangeTrackingPolicy: object

serializedName

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

type

type: object

className

className: string = "SqlIntegratedChangeTrackingPolicy"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = DataChangeDetectionPolicy.type.polymorphicDiscriminator

uberParent

uberParent: string = "DataChangeDetectionPolicy"

modelProperties

modelProperties: object

Const StemmerOverrideTokenFilter

StemmerOverrideTokenFilter: object

serializedName

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

type

type: object

className

className: string = "StemmerOverrideTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

rules

rules: object

required

required: boolean = true

serializedName

serializedName: string = "rules"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const StemmerTokenFilter

StemmerTokenFilter: object

serializedName

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

type

type: object

className

className: string = "StemmerTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

language

language: object

required

required: boolean = true

serializedName

serializedName: string = "language"

type

type: object

allowedValues

allowedValues: string[] = ["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"]

name

name: string = "Enum"

Const StopAnalyzer

StopAnalyzer: object

serializedName

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

type

type: object

className

className: string = "StopAnalyzer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalAnalyzer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalAnalyzer"

modelProperties

modelProperties: object

stopwords

stopwords: object

serializedName

serializedName: string = "stopwords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const StopwordsTokenFilter

StopwordsTokenFilter: object

serializedName

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

type

type: object

className

className: string = "StopwordsTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

ignoreCase

ignoreCase: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ignoreCase"

type

type: object

name

name: string = "Boolean"

removeTrailingStopWords

removeTrailingStopWords: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "removeTrailing"

type

type: object

name

name: string = "Boolean"

stopwords

stopwords: object

serializedName

serializedName: string = "stopwords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

stopwordsList

stopwordsList: object

serializedName

serializedName: string = "stopwordsList"

type

type: object

allowedValues

allowedValues: string[] = ["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"]

name

name: string = "Enum"

Const SuggestDocumentsResult

SuggestDocumentsResult: object

serializedName

serializedName: string = "SuggestDocumentsResult"

type

type: object

className

className: string = "SuggestDocumentsResult"

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 = "SuggestResult"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

Const SuggestOptions

SuggestOptions: object

type

type: object

className

className: string = "SuggestOptions"

name

name: string = "Composite"

modelProperties

modelProperties: object

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"

orderBy

orderBy: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

searchFields

searchFields: object

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

select

select: 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 SuggestRequest

SuggestRequest: object

serializedName

serializedName: string = "SuggestRequest"

type

type: object

className

className: string = "SuggestRequest"

name

name: string = "Composite"

modelProperties

modelProperties: object

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"

orderBy

orderBy: object

serializedName

serializedName: string = "orderby"

type

type: object

name

name: string = "String"

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"

select

select: object

serializedName

serializedName: string = "select"

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 SuggestResult

SuggestResult: object

serializedName

serializedName: string = "SuggestResult"

type

type: object

className

className: string = "SuggestResult"

name

name: string = "Composite"

additionalProperties

additionalProperties: object

type

type: object

name

name: string = "Object"

modelProperties

modelProperties: object

_text

_text: object

readOnly

readOnly: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "@search\.text"

type

type: object

name

name: string = "String"

Const Suggester

Suggester: object

serializedName

serializedName: string = "Suggester"

type

type: object

className

className: string = "Suggester"

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"

searchMode

searchMode: object

defaultValue

defaultValue: string = "analyzingInfixMatching"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "searchMode"

type

type: object

name

name: string = "String"

sourceFields

sourceFields: object

required

required: boolean = true

serializedName

serializedName: string = "sourceFields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const SynonymMap

SynonymMap: object

serializedName

serializedName: string = "SynonymMap"

type

type: object

className

className: string = "SynonymMap"

name

name: string = "Composite"

modelProperties

modelProperties: object

encryptionKey

encryptionKey: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "encryptionKey"

type

type: object

className

className: string = "SearchResourceEncryptionKey"

name

name: string = "Composite"

etag

etag: object

serializedName

serializedName: string = "@odata\.etag"

type

type: object

name

name: string = "String"

format

format: object

defaultValue

defaultValue: string = "solr"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "format"

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"

synonyms

synonyms: object

required

required: boolean = true

serializedName

serializedName: string = "synonyms"

type

type: object

name

name: string = "String"

Const SynonymTokenFilter

SynonymTokenFilter: object

serializedName

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

type

type: object

className

className: string = "SynonymTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

expand

expand: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "expand"

type

type: object

name

name: string = "Boolean"

ignoreCase

ignoreCase: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "ignoreCase"

type

type: object

name

name: string = "Boolean"

synonyms

synonyms: object

required

required: boolean = true

serializedName

serializedName: string = "synonyms"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const TagScoringFunction

TagScoringFunction: object

serializedName

serializedName: string = "tag"

type

type: object

className

className: string = "TagScoringFunction"

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 = "tag"

type

type: object

className

className: string = "TagScoringParameters"

name

name: string = "Composite"

Const TagScoringParameters

TagScoringParameters: object

serializedName

serializedName: string = "TagScoringParameters"

type

type: object

className

className: string = "TagScoringParameters"

name

name: string = "Composite"

modelProperties

modelProperties: object

tagsParameter

tagsParameter: object

required

required: boolean = true

serializedName

serializedName: string = "tagsParameter"

type

type: object

name

name: string = "String"

Const TextTranslationSkill

TextTranslationSkill: object

serializedName

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

type

type: object

className

className: string = "TextTranslationSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

defaultFromLanguageCode

defaultFromLanguageCode: object

serializedName

serializedName: string = "defaultFromLanguageCode"

type

type: object

name

name: string = "String"

defaultToLanguageCode

defaultToLanguageCode: object

required

required: boolean = true

serializedName

serializedName: string = "defaultToLanguageCode"

type

type: object

name

name: string = "String"

suggestedFrom

suggestedFrom: object

serializedName

serializedName: string = "suggestedFrom"

type

type: object

name

name: string = "String"

Const TextWeights

TextWeights: object

serializedName

serializedName: string = "TextWeights"

type

type: object

className

className: string = "TextWeights"

name

name: string = "Composite"

modelProperties

modelProperties: object

weights

weights: object

required

required: boolean = true

serializedName

serializedName: string = "weights"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "Number"

Const TokenFilter

TokenFilter: object

serializedName

serializedName: string = "TokenFilter"

type

type: object

className

className: string = "TokenFilter"

name

name: string = "Composite"

uberParent

uberParent: string = "TokenFilter"

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 TruncateTokenFilter

TruncateTokenFilter: object

serializedName

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

type

type: object

className

className: string = "TruncateTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

length

length: object

defaultValue

defaultValue: number = 300

serializedName

serializedName: string = "length"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 300

type

type: object

name

name: string = "Number"

Const UaxUrlEmailTokenizer

UaxUrlEmailTokenizer: object

serializedName

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

type

type: object

className

className: string = "UaxUrlEmailTokenizer"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = LexicalTokenizer.type.polymorphicDiscriminator

uberParent

uberParent: string = "LexicalTokenizer"

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 UniqueTokenFilter

UniqueTokenFilter: object

serializedName

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

type

type: object

className

className: string = "UniqueTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

onlyOnSamePosition

onlyOnSamePosition: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "onlyOnSamePosition"

type

type: object

name

name: string = "Boolean"

Const WebApiSkill

WebApiSkill: object

serializedName

serializedName: string = "#Microsoft.Skills.Custom.WebApiSkill"

type

type: object

className

className: string = "WebApiSkill"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = SearchIndexerSkill.type.polymorphicDiscriminator

uberParent

uberParent: string = "SearchIndexerSkill"

modelProperties

modelProperties: object

batchSize

batchSize: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "batchSize"

type

type: object

name

name: string = "Number"

degreeOfParallelism

degreeOfParallelism: object

nullable

nullable: boolean = true

serializedName

serializedName: string = "degreeOfParallelism"

type

type: object

name

name: string = "Number"

httpHeaders

httpHeaders: object

serializedName

serializedName: string = "httpHeaders"

type

type: object

name

name: string = "Dictionary"

value

value: object

type

type: object

name

name: string = "String"

httpMethod

httpMethod: object

serializedName

serializedName: string = "httpMethod"

type

type: object

name

name: string = "String"

timeout

timeout: object

serializedName

serializedName: string = "timeout"

type

type: object

name

name: string = "TimeSpan"

uri

uri: object

required

required: boolean = true

serializedName

serializedName: string = "uri"

type

type: object

name

name: string = "String"

Const WordDelimiterTokenFilter

WordDelimiterTokenFilter: object

serializedName

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

type

type: object

className

className: string = "WordDelimiterTokenFilter"

name

name: string = "Composite"

polymorphicDiscriminator

polymorphicDiscriminator: any = TokenFilter.type.polymorphicDiscriminator

uberParent

uberParent: string = "TokenFilter"

modelProperties

modelProperties: object

catenateAll

catenateAll: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "catenateAll"

type

type: object

name

name: string = "Boolean"

catenateNumbers

catenateNumbers: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "catenateNumbers"

type

type: object

name

name: string = "Boolean"

catenateWords

catenateWords: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "catenateWords"

type

type: object

name

name: string = "Boolean"

generateNumberParts

generateNumberParts: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "generateNumberParts"

type

type: object

name

name: string = "Boolean"

generateWordParts

generateWordParts: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "generateWordParts"

type

type: object

name

name: string = "Boolean"

preserveOriginal

preserveOriginal: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "preserveOriginal"

type

type: object

name

name: string = "Boolean"

protectedWords

protectedWords: object

serializedName

serializedName: string = "protectedWords"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

splitOnCaseChange

splitOnCaseChange: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "splitOnCaseChange"

type

type: object

name

name: string = "Boolean"

splitOnNumerics

splitOnNumerics: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "splitOnNumerics"

type

type: object

name

name: string = "Boolean"

stemEnglishPossessive

stemEnglishPossessive: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "stemEnglishPossessive"

type

type: object

name

name: string = "Boolean"

Const allowIndexDowntime

allowIndexDowntime: object

parameterPath

parameterPath: string[] = ["options","allowIndexDowntime"]

mapper

mapper: object

serializedName

serializedName: string = "allowIndexDowntime"

type

type: object

name

name: string = "Boolean"

Const analyzeOperationSpec

analyzeOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "indexes('{indexName}')/search.analyze"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

requestBody

requestBody: object

parameterPath

parameterPath: string = "request"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AnalyzeResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: string = "String"

Const autocompleteGetOperationSpec

autocompleteGetOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "docs/search.autocomplete"

queryParameters

queryParameters: any[] = [Parameters.apiVersion,Parameters.searchText1,Parameters.suggesterName,Parameters.autocompleteMode,Parameters.filter2,Parameters.useFuzzyMatching1,Parameters.highlightPostTag2,Parameters.highlightPreTag2,Parameters.minimumCoverage2,Parameters.searchFields2,Parameters.top2]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AutocompleteResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const autocompleteMode

autocompleteMode: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","autocompleteMode"]

mapper

mapper: object

serializedName

serializedName: string = "autocompleteMode"

type

type: object

allowedValues

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

name

name: string = "Enum"

Const autocompletePostOperationSpec

autocompletePostOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "docs/search.post.autocomplete"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

requestBody

requestBody: object

parameterPath

parameterPath: string = "autocompleteRequest"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.AutocompleteResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const countOperationSpec

countOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "docs/$count"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: object

serializedName

serializedName: string = "parsedResponse"

type

type: object

name

name: string = "Number"

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const createOperationSpec

createOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "indexes"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

requestBody

requestBody: object

parameterPath

parameterPath: string = "index"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

201

201: object

bodyMapper

bodyMapper: any = Mappers.SearchIndex

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const createOrUpdateOperationSpec

createOrUpdateOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.ifMatch,Parameters.ifNoneMatch,Parameters.prefer]

httpMethod

httpMethod: string = "PUT"

path

path: string = "indexes('{indexName}')"

queryParameters

queryParameters: any[] = [Parameters.allowIndexDowntime,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

requestBody

requestBody: object

parameterPath

parameterPath: string = "index"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SearchIndex

201

201: object

bodyMapper

bodyMapper: any = Mappers.SearchIndex

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const dataSourceName

dataSourceName: object

parameterPath

parameterPath: string = "dataSourceName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "dataSourceName"

type

type: object

name

name: string = "String"

Const deleteMethodOperationSpec

deleteMethodOperationSpec: object

headerParameters

headerParameters: any[] = [Parameters.ifMatch,Parameters.ifNoneMatch]

httpMethod

httpMethod: string = "DELETE"

path

path: string = "indexes('{indexName}')"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

204

204: {}

Type declaration

404

404: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const discriminators

discriminators: object

CharFilter

CharFilter: any = CharFilter

CharFilter.#Microsoft.Azure.Search.MappingCharFilter

CharFilter.#Microsoft.Azure.Search.MappingCharFilter: any = MappingCharFilter

CharFilter.#Microsoft.Azure.Search.PatternReplaceCharFilter

CharFilter.#Microsoft.Azure.Search.PatternReplaceCharFilter: any = PatternReplaceCharFilter

CognitiveServicesAccount

CognitiveServicesAccount: any = CognitiveServicesAccount

CognitiveServicesAccount.#Microsoft.Azure.Search.CognitiveServicesByKey

CognitiveServicesAccount.#Microsoft.Azure.Search.CognitiveServicesByKey: any = CognitiveServicesAccountKey

CognitiveServicesAccount.#Microsoft.Azure.Search.DefaultCognitiveServices

CognitiveServicesAccount.#Microsoft.Azure.Search.DefaultCognitiveServices: any = DefaultCognitiveServicesAccount

DataChangeDetectionPolicy

DataChangeDetectionPolicy: any = DataChangeDetectionPolicy

DataChangeDetectionPolicy.#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy

DataChangeDetectionPolicy.#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy: any = HighWaterMarkChangeDetectionPolicy

DataChangeDetectionPolicy.#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy

DataChangeDetectionPolicy.#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy: any = SqlIntegratedChangeTrackingPolicy

DataDeletionDetectionPolicy

DataDeletionDetectionPolicy: any = DataDeletionDetectionPolicy

DataDeletionDetectionPolicy.#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy

DataDeletionDetectionPolicy.#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy: any = SoftDeleteColumnDeletionDetectionPolicy

LexicalAnalyzer

LexicalAnalyzer: any = LexicalAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.CustomAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.CustomAnalyzer: any = CustomAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.PatternAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.PatternAnalyzer: any = PatternAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.StandardAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.StandardAnalyzer: any = LuceneStandardAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.StopAnalyzer

LexicalAnalyzer.#Microsoft.Azure.Search.StopAnalyzer: any = StopAnalyzer

LexicalTokenizer

LexicalTokenizer: any = LexicalTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.ClassicTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.ClassicTokenizer: any = ClassicTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.EdgeNGramTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.EdgeNGramTokenizer: any = EdgeNGramTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.KeywordTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.KeywordTokenizer: any = KeywordTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.KeywordTokenizerV2

LexicalTokenizer.#Microsoft.Azure.Search.KeywordTokenizerV2: any = KeywordTokenizerV2

LexicalTokenizer.#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer: any = MicrosoftLanguageStemmingTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.MicrosoftLanguageTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.MicrosoftLanguageTokenizer: any = MicrosoftLanguageTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.NGramTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.NGramTokenizer: any = NGramTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.PathHierarchyTokenizerV2

LexicalTokenizer.#Microsoft.Azure.Search.PathHierarchyTokenizerV2: any = PathHierarchyTokenizerV2

LexicalTokenizer.#Microsoft.Azure.Search.PatternTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.PatternTokenizer: any = PatternTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.StandardTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.StandardTokenizer: any = LuceneStandardTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.StandardTokenizerV2

LexicalTokenizer.#Microsoft.Azure.Search.StandardTokenizerV2: any = LuceneStandardTokenizerV2

LexicalTokenizer.#Microsoft.Azure.Search.UaxUrlEmailTokenizer

LexicalTokenizer.#Microsoft.Azure.Search.UaxUrlEmailTokenizer: any = UaxUrlEmailTokenizer

ScoringFunction

ScoringFunction: any = ScoringFunction

ScoringFunction.distance

ScoringFunction.distance: any = DistanceScoringFunction

ScoringFunction.freshness

ScoringFunction.freshness: any = FreshnessScoringFunction

ScoringFunction.magnitude

ScoringFunction.magnitude: any = MagnitudeScoringFunction

ScoringFunction.tag

ScoringFunction.tag: any = TagScoringFunction

SearchIndexerSkill

SearchIndexerSkill: any = SearchIndexerSkill

SearchIndexerSkill.#Microsoft.Skills.Custom.WebApiSkill

SearchIndexerSkill.#Microsoft.Skills.Custom.WebApiSkill: any = WebApiSkill

SearchIndexerSkill.#Microsoft.Skills.Text.EntityRecognitionSkill

SearchIndexerSkill.#Microsoft.Skills.Text.EntityRecognitionSkill: any = EntityRecognitionSkill

SearchIndexerSkill.#Microsoft.Skills.Text.KeyPhraseExtractionSkill

SearchIndexerSkill.#Microsoft.Skills.Text.KeyPhraseExtractionSkill: any = KeyPhraseExtractionSkill

SearchIndexerSkill.#Microsoft.Skills.Text.LanguageDetectionSkill

SearchIndexerSkill.#Microsoft.Skills.Text.LanguageDetectionSkill: any = LanguageDetectionSkill

SearchIndexerSkill.#Microsoft.Skills.Text.MergeSkill

SearchIndexerSkill.#Microsoft.Skills.Text.MergeSkill: any = MergeSkill

SearchIndexerSkill.#Microsoft.Skills.Text.SentimentSkill

SearchIndexerSkill.#Microsoft.Skills.Text.SentimentSkill: any = SentimentSkill

SearchIndexerSkill.#Microsoft.Skills.Text.SplitSkill

SearchIndexerSkill.#Microsoft.Skills.Text.SplitSkill: any = SplitSkill

SearchIndexerSkill.#Microsoft.Skills.Text.TranslationSkill

SearchIndexerSkill.#Microsoft.Skills.Text.TranslationSkill: any = TextTranslationSkill

SearchIndexerSkill.#Microsoft.Skills.Util.ConditionalSkill

SearchIndexerSkill.#Microsoft.Skills.Util.ConditionalSkill: any = ConditionalSkill

SearchIndexerSkill.#Microsoft.Skills.Util.ShaperSkill

SearchIndexerSkill.#Microsoft.Skills.Util.ShaperSkill: any = ShaperSkill

SearchIndexerSkill.#Microsoft.Skills.Vision.ImageAnalysisSkill

SearchIndexerSkill.#Microsoft.Skills.Vision.ImageAnalysisSkill: any = ImageAnalysisSkill

SearchIndexerSkill.#Microsoft.Skills.Vision.OcrSkill

SearchIndexerSkill.#Microsoft.Skills.Vision.OcrSkill: any = OcrSkill

Similarity

Similarity: any = Similarity

Similarity.#Microsoft.Azure.Search.BM25Similarity

Similarity.#Microsoft.Azure.Search.BM25Similarity: any = BM25Similarity

Similarity.#Microsoft.Azure.Search.ClassicSimilarity

Similarity.#Microsoft.Azure.Search.ClassicSimilarity: any = ClassicSimilarity

TokenFilter

TokenFilter: any = TokenFilter

TokenFilter.#Microsoft.Azure.Search.AsciiFoldingTokenFilter

TokenFilter.#Microsoft.Azure.Search.AsciiFoldingTokenFilter: any = AsciiFoldingTokenFilter

TokenFilter.#Microsoft.Azure.Search.CjkBigramTokenFilter

TokenFilter.#Microsoft.Azure.Search.CjkBigramTokenFilter: any = CjkBigramTokenFilter

TokenFilter.#Microsoft.Azure.Search.CommonGramTokenFilter

TokenFilter.#Microsoft.Azure.Search.CommonGramTokenFilter: any = CommonGramTokenFilter

TokenFilter.#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter

TokenFilter.#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter: any = DictionaryDecompounderTokenFilter

TokenFilter.#Microsoft.Azure.Search.EdgeNGramTokenFilter

TokenFilter.#Microsoft.Azure.Search.EdgeNGramTokenFilter: any = EdgeNGramTokenFilter

TokenFilter.#Microsoft.Azure.Search.EdgeNGramTokenFilterV2

TokenFilter.#Microsoft.Azure.Search.EdgeNGramTokenFilterV2: any = EdgeNGramTokenFilterV2

TokenFilter.#Microsoft.Azure.Search.ElisionTokenFilter

TokenFilter.#Microsoft.Azure.Search.ElisionTokenFilter: any = ElisionTokenFilter

TokenFilter.#Microsoft.Azure.Search.KeepTokenFilter

TokenFilter.#Microsoft.Azure.Search.KeepTokenFilter: any = KeepTokenFilter

TokenFilter.#Microsoft.Azure.Search.KeywordMarkerTokenFilter

TokenFilter.#Microsoft.Azure.Search.KeywordMarkerTokenFilter: any = KeywordMarkerTokenFilter

TokenFilter.#Microsoft.Azure.Search.LengthTokenFilter

TokenFilter.#Microsoft.Azure.Search.LengthTokenFilter: any = LengthTokenFilter

TokenFilter.#Microsoft.Azure.Search.LimitTokenFilter

TokenFilter.#Microsoft.Azure.Search.LimitTokenFilter: any = LimitTokenFilter

TokenFilter.#Microsoft.Azure.Search.NGramTokenFilter

TokenFilter.#Microsoft.Azure.Search.NGramTokenFilter: any = NGramTokenFilter

TokenFilter.#Microsoft.Azure.Search.NGramTokenFilterV2

TokenFilter.#Microsoft.Azure.Search.NGramTokenFilterV2: any = NGramTokenFilterV2

TokenFilter.#Microsoft.Azure.Search.PatternCaptureTokenFilter

TokenFilter.#Microsoft.Azure.Search.PatternCaptureTokenFilter: any = PatternCaptureTokenFilter

TokenFilter.#Microsoft.Azure.Search.PatternReplaceTokenFilter

TokenFilter.#Microsoft.Azure.Search.PatternReplaceTokenFilter: any = PatternReplaceTokenFilter

TokenFilter.#Microsoft.Azure.Search.PhoneticTokenFilter

TokenFilter.#Microsoft.Azure.Search.PhoneticTokenFilter: any = PhoneticTokenFilter

TokenFilter.#Microsoft.Azure.Search.ShingleTokenFilter

TokenFilter.#Microsoft.Azure.Search.ShingleTokenFilter: any = ShingleTokenFilter

TokenFilter.#Microsoft.Azure.Search.SnowballTokenFilter

TokenFilter.#Microsoft.Azure.Search.SnowballTokenFilter: any = SnowballTokenFilter

TokenFilter.#Microsoft.Azure.Search.StemmerOverrideTokenFilter

TokenFilter.#Microsoft.Azure.Search.StemmerOverrideTokenFilter: any = StemmerOverrideTokenFilter

TokenFilter.#Microsoft.Azure.Search.StemmerTokenFilter

TokenFilter.#Microsoft.Azure.Search.StemmerTokenFilter: any = StemmerTokenFilter

TokenFilter.#Microsoft.Azure.Search.StopwordsTokenFilter

TokenFilter.#Microsoft.Azure.Search.StopwordsTokenFilter: any = StopwordsTokenFilter

TokenFilter.#Microsoft.Azure.Search.SynonymTokenFilter

TokenFilter.#Microsoft.Azure.Search.SynonymTokenFilter: any = SynonymTokenFilter

TokenFilter.#Microsoft.Azure.Search.TruncateTokenFilter

TokenFilter.#Microsoft.Azure.Search.TruncateTokenFilter: any = TruncateTokenFilter

TokenFilter.#Microsoft.Azure.Search.UniqueTokenFilter

TokenFilter.#Microsoft.Azure.Search.UniqueTokenFilter: any = UniqueTokenFilter

TokenFilter.#Microsoft.Azure.Search.WordDelimiterTokenFilter

TokenFilter.#Microsoft.Azure.Search.WordDelimiterTokenFilter: any = WordDelimiterTokenFilter

Const endpoint

endpoint: object

parameterPath

parameterPath: string = "endpoint"

skipEncoding

skipEncoding: boolean = true

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "endpoint"

type

type: object

name

name: string = "String"

Const facets

facets: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Multi

parameterPath

parameterPath: string[] = ["options","searchOptions","facets"]

mapper

mapper: object

serializedName

serializedName: string = "facet"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const filter0

filter0: object

parameterPath

parameterPath: string[] = ["options","searchOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: string = "String"

Const filter1

filter1: object

parameterPath

parameterPath: string[] = ["options","suggestOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: string = "String"

Const filter2

filter2: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: string = "String"

Const getOperationSpec

getOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "indexes('{indexName}')"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: object = Mappers.SearchIndex

serializedName

serializedName: string = "parsedResponse"

type

type: object

name

name: string = "Object"

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const getServiceStatisticsOperationSpec

getServiceStatisticsOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "servicestats"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ServiceStatistics

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const getStatisticsOperationSpec

getStatisticsOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "indexes('{indexName}')/search.stats"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.GetIndexStatisticsResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const getStatusOperationSpec

getStatusOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "indexers('{indexerName}')/search.status"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexerName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SearchIndexerStatus

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const highlightFields

highlightFields: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","searchOptions","highlightFields"]

mapper

mapper: object

serializedName

serializedName: string = "highlight"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const highlightPostTag0

highlightPostTag0: object

parameterPath

parameterPath: string[] = ["options","searchOptions","highlightPostTag"]

mapper

mapper: object

serializedName

serializedName: string = "highlightPostTag"

type

type: object

name

name: string = "String"

Const highlightPostTag1

highlightPostTag1: object

parameterPath

parameterPath: string[] = ["options","suggestOptions","highlightPostTag"]

mapper

mapper: object

serializedName

serializedName: string = "highlightPostTag"

type

type: object

name

name: string = "String"

Const highlightPostTag2

highlightPostTag2: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","highlightPostTag"]

mapper

mapper: object

serializedName

serializedName: string = "highlightPostTag"

type

type: object

name

name: string = "String"

Const highlightPreTag0

highlightPreTag0: object

parameterPath

parameterPath: string[] = ["options","searchOptions","highlightPreTag"]

mapper

mapper: object

serializedName

serializedName: string = "highlightPreTag"

type

type: object

name

name: string = "String"

Const highlightPreTag1

highlightPreTag1: object

parameterPath

parameterPath: string[] = ["options","suggestOptions","highlightPreTag"]

mapper

mapper: object

serializedName

serializedName: string = "highlightPreTag"

type

type: object

name

name: string = "String"

Const highlightPreTag2

highlightPreTag2: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","highlightPreTag"]

mapper

mapper: object

serializedName

serializedName: string = "highlightPreTag"

type

type: object

name

name: string = "String"

Const ifMatch

ifMatch: object

parameterPath

parameterPath: string[] = ["options","ifMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-Match"

type

type: object

name

name: string = "String"

Const ifNoneMatch

ifNoneMatch: object

parameterPath

parameterPath: string[] = ["options","ifNoneMatch"]

mapper

mapper: object

serializedName

serializedName: string = "If-None-Match"

type

type: object

name

name: string = "String"

Const includeTotalResultCount

includeTotalResultCount: object

parameterPath

parameterPath: string[] = ["options","searchOptions","includeTotalResultCount"]

mapper

mapper: object

serializedName

serializedName: string = "$count"

type

type: object

name

name: string = "Boolean"

Const indexName

indexName: object

parameterPath

parameterPath: string = "indexName"

mapper

mapper: object

defaultValue

defaultValue: string = ""

required

required: boolean = true

serializedName

serializedName: string = "indexName"

type

type: object

name

name: string = "String"

Const indexOperationSpec

indexOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "docs/search.index"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

requestBody

requestBody: object

parameterPath

parameterPath: string = "batch"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.IndexDocumentsResult

207

207: object

bodyMapper

bodyMapper: any = Mappers.IndexDocumentsResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const indexerName

indexerName: object

parameterPath

parameterPath: string = "indexerName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "indexerName"

type

type: object

name

name: string = "String"

Const key

key: object

parameterPath

parameterPath: string = "key"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "key"

type

type: object

name

name: string = "String"

Const listOperationSpec

listOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "indexes"

queryParameters

queryParameters: any[] = [Parameters.select,Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.ListIndexesResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const minimumCoverage0

minimumCoverage0: object

parameterPath

parameterPath: string[] = ["options","searchOptions","minimumCoverage"]

mapper

mapper: object

serializedName

serializedName: string = "minimumCoverage"

type

type: object

name

name: string = "Number"

Const minimumCoverage1

minimumCoverage1: object

parameterPath

parameterPath: string[] = ["options","suggestOptions","minimumCoverage"]

mapper

mapper: object

serializedName

serializedName: string = "minimumCoverage"

type

type: object

name

name: string = "Number"

Const minimumCoverage2

minimumCoverage2: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","minimumCoverage"]

mapper

mapper: object

serializedName

serializedName: string = "minimumCoverage"

type

type: object

name

name: string = "Number"

Const orderBy0

orderBy0: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","searchOptions","orderBy"]

mapper

mapper: object

serializedName

serializedName: string = "$orderby"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const orderBy1

orderBy1: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","suggestOptions","orderBy"]

mapper

mapper: object

serializedName

serializedName: string = "$orderby"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const prefer

prefer: object

parameterPath

parameterPath: string = "prefer"

mapper

mapper: object

defaultValue

defaultValue: string = "return=representation"

isConstant

isConstant: boolean = true

required

required: boolean = true

serializedName

serializedName: string = "Prefer"

type

type: object

name

name: string = "String"

Const queryType

queryType: object

parameterPath

parameterPath: string[] = ["options","searchOptions","queryType"]

mapper

mapper: object

serializedName

serializedName: string = "queryType"

type

type: object

allowedValues

allowedValues: string[] = ["simple","full"]

name

name: string = "Enum"

Const resetOperationSpec

resetOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "indexers('{indexerName}')/search.reset"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexerName]

responses

responses: object

204

204: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const runOperationSpec

runOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "indexers('{indexerName}')/search.run"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexerName]

responses

responses: object

202

202: {}

Type declaration

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const scoringParameters

scoringParameters: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Multi

parameterPath

parameterPath: string[] = ["options","searchOptions","scoringParameters"]

mapper

mapper: object

serializedName

serializedName: string = "scoringParameter"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const scoringProfile

scoringProfile: object

parameterPath

parameterPath: string[] = ["options","searchOptions","scoringProfile"]

mapper

mapper: object

serializedName

serializedName: string = "scoringProfile"

type

type: object

name

name: string = "String"

Const scoringStatistics

scoringStatistics: object

parameterPath

parameterPath: string[] = ["options","searchOptions","scoringStatistics"]

mapper

mapper: object

serializedName

serializedName: string = "scoringStatistics"

type

type: object

allowedValues

allowedValues: string[] = ["local","global"]

name

name: string = "Enum"

Const searchFields0

searchFields0: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","searchOptions","searchFields"]

mapper

mapper: object

serializedName

serializedName: string = "searchFields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const searchFields1

searchFields1: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","suggestOptions","searchFields"]

mapper

mapper: object

serializedName

serializedName: string = "searchFields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const searchFields2

searchFields2: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","searchFields"]

mapper

mapper: object

serializedName

serializedName: string = "searchFields"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const searchGetOperationSpec

searchGetOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "docs"

queryParameters

queryParameters: any[] = [Parameters.searchText0,Parameters.apiVersion,Parameters.includeTotalResultCount,Parameters.facets,Parameters.filter0,Parameters.highlightFields,Parameters.highlightPostTag0,Parameters.highlightPreTag0,Parameters.minimumCoverage0,Parameters.orderBy0,Parameters.queryType,Parameters.scoringParameters,Parameters.scoringProfile,Parameters.searchFields0,Parameters.searchMode,Parameters.scoringStatistics,Parameters.sessionId,Parameters.select0,Parameters.skip,Parameters.top0]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SearchDocumentsResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const searchMode

searchMode: object

parameterPath

parameterPath: string[] = ["options","searchOptions","searchMode"]

mapper

mapper: object

serializedName

serializedName: string = "searchMode"

type

type: object

allowedValues

allowedValues: string[] = ["any","all"]

name

name: string = "Enum"

Const searchPostOperationSpec

searchPostOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "docs/search.post.search"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

requestBody

requestBody: object

parameterPath

parameterPath: string = "searchRequest"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SearchDocumentsResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const searchText0

searchText0: object

parameterPath

parameterPath: string[] = ["options","searchText"]

mapper

mapper: object

serializedName

serializedName: string = "search"

type

type: object

name

name: string = "String"

Const searchText1

searchText1: object

parameterPath

parameterPath: string = "searchText"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "search"

type

type: object

name

name: string = "String"

Const select

select: object

parameterPath

parameterPath: string[] = ["options","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: string = "String"

Const select0

select0: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","searchOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const select1

select1: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","suggestOptions","select"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const selectedFields

selectedFields: object

collectionFormat

collectionFormat: any = coreHttp.QueryCollectionFormat.Csv

parameterPath

parameterPath: string[] = ["options","selectedFields"]

mapper

mapper: object

serializedName

serializedName: string = "$select"

type

type: object

name

name: string = "Sequence"

element

element: object

type

type: object

name

name: string = "String"

Const sessionId

sessionId: object

parameterPath

parameterPath: string[] = ["options","searchOptions","sessionId"]

mapper

mapper: object

serializedName

serializedName: string = "sessionId"

type

type: object

name

name: string = "String"

Const skillsetName

skillsetName: object

parameterPath

parameterPath: string = "skillsetName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "skillsetName"

type

type: object

name

name: string = "String"

Const skip

skip: object

parameterPath

parameterPath: string[] = ["options","searchOptions","skip"]

mapper

mapper: object

serializedName

serializedName: string = "$skip"

type

type: object

name

name: string = "Number"

Const suggestGetOperationSpec

suggestGetOperationSpec: object

httpMethod

httpMethod: string = "GET"

path

path: string = "docs/search.suggest"

queryParameters

queryParameters: any[] = [Parameters.searchText1,Parameters.suggesterName,Parameters.apiVersion,Parameters.filter1,Parameters.useFuzzyMatching0,Parameters.highlightPostTag1,Parameters.highlightPreTag1,Parameters.minimumCoverage1,Parameters.orderBy1,Parameters.searchFields1,Parameters.select1,Parameters.top1]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SuggestDocumentsResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const suggestPostOperationSpec

suggestPostOperationSpec: object

httpMethod

httpMethod: string = "POST"

path

path: string = "docs/search.post.suggest"

queryParameters

queryParameters: any[] = [Parameters.apiVersion]

serializer

serializer: any

urlParameters

urlParameters: any[] = [Parameters.endpoint,Parameters.indexName]

requestBody

requestBody: object

parameterPath

parameterPath: string = "suggestRequest"

mapper

mapper: object

required

required: boolean = true

responses

responses: object

200

200: object

bodyMapper

bodyMapper: any = Mappers.SuggestDocumentsResult

default

default: object

bodyMapper

bodyMapper: any = Mappers.SearchError

Const suggesterName

suggesterName: object

parameterPath

parameterPath: string = "suggesterName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "suggesterName"

type

type: object

name

name: string = "String"

Const synonymMapName

synonymMapName: object

parameterPath

parameterPath: string = "synonymMapName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "synonymMapName"

type

type: object

name

name: string = "String"

Const top0

top0: object

parameterPath

parameterPath: string[] = ["options","searchOptions","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: string = "Number"

Const top1

top1: object

parameterPath

parameterPath: string[] = ["options","suggestOptions","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: string = "Number"

Const top2

top2: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: string = "Number"

Const useFuzzyMatching0

useFuzzyMatching0: object

parameterPath

parameterPath: string[] = ["options","suggestOptions","useFuzzyMatching"]

mapper

mapper: object

serializedName

serializedName: string = "fuzzy"

type

type: object

name

name: string = "Boolean"

Const useFuzzyMatching1

useFuzzyMatching1: object

parameterPath

parameterPath: string[] = ["options","autocompleteOptions","useFuzzyMatching"]

mapper

mapper: object

serializedName

serializedName: string = "fuzzy"

type

type: object

name

name: string = "Boolean"

Generated using TypeDoc