Defines values for AutocompleteMode. Possible values include: 'OneTerm', 'TwoTerms', 'OneTermWithContext'
Defines values for CharFilterName. Possible values include: 'HtmlStrip'
Contains the possible cases for CharFilter.
Defines values for CjkBigramTokenFilterScripts. Possible values include: 'Han', 'Hiragana', 'Katakana', 'Hangul'
Contains the possible cases for CognitiveServicesAccount.
Defines values for ComplexDataType. Possible values include: 'Edm.ComplexType', 'Collection(Edm.ComplexType)'
Options for performing the count operation on the index.
Options for create datasource operation.
Options for create index operation.
Options for create indexer operation.
Options for create skillset operation.
Options for create synonymmap operation.
Contains the possible cases for DataChangeDetectionPolicy.
Contains the possible cases for DataDeletionDetectionPolicy.
Contains response data for the createOrUpdate operation.
Contains response data for the create operation.
Contains response data for the get operation.
Contains response data for the list operation.
Options for the delete documents operation.
Contains response data for the autocompleteGet operation.
Contains response data for the autocompletePost operation.
Contains response data for the count operation.
The underlying HTTP response.
The parsed response body.
Contains response data for the get operation.
The underlying HTTP response.
The parsed response body.
Contains response data for the index operation.
Contains response data for the searchGet operation.
Contains response data for the searchPost operation.
Contains response data for the suggestGet operation.
Contains response data for the suggestPost operation.
Defines values for EdgeNGramTokenFilterSide. Possible values include: 'Front', 'Back'
Defines values for EntityCategory. Possible values include: 'Location', 'Organization', 'Person', 'Quantity', 'Datetime', 'Url', 'Email'
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'
Options for get datasource operation.
Options for get index operation.
Options for get index statistics operation.
Options for get indexer operation.
Options for get indexer status operation.
Options for get service statistics operation.
Contains response data for the getServiceStatistics operation.
Options for get skillset operation.
Options for get synonymmaps operation.
Defines values for ImageAnalysisSkillLanguage. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'
Defines values for ImageDetail. Possible values include: 'Celebrities', 'Landmarks'
Defines values for IndexActionType. Possible values include: 'Upload', 'Merge', 'MergeOrUpload', 'Delete'
Represents an index action that operates on a document.
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.
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.
Defines values for IndexerExecutionStatus. Possible values include: 'TransientFailure', 'Success', 'InProgress', 'Reset'
Defines values for IndexerStatus. Possible values include: 'Unknown', 'Error', 'Running'
Contains response data for the createOrUpdate operation.
Contains response data for the create operation.
Contains response data for the get operation.
Contains response data for the getStatus operation.
Contains response data for the list operation.
Contains response data for the analyze operation.
Contains response data for the createOrUpdate operation.
Contains response data for the create operation.
Contains response data for the get operation.
Contains response data for the getStatistics operation.
Contains response data for the list operation.
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'
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'
Contains the possible cases for LexicalAnalyzer.
Defines values for LexicalTokenizerName. Possible values include: 'Classic', 'EdgeNGram', 'Keyword', 'Letter', 'Lowercase', 'MicrosoftLanguageTokenizer', 'MicrosoftLanguageStemmingTokenizer', 'NGram', 'PathHierarchy', 'Pattern', 'Standard', 'UaxUrlEmail', 'Whitespace'
Contains the possible cases for LexicalTokenizer.
Options for a list data sources operation.
Options for a list indexers operation.
Options for a list indexes operation.
Options for a list skillsets operation.
Options for a list synonymMaps operation.
Options for the merge documents operation.
Options for the merge or upload documents operation.
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'
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'
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'
Defines values for PhoneticEncoder. Possible values include: 'Metaphone', 'DoubleMetaphone', 'Soundex', 'RefinedSoundex', 'Caverphone1', 'Caverphone2', 'Cologne', 'Nysiis', 'KoelnerPhonetik', 'HaasePhonetik', 'BeiderMorse'
Defines values for QueryType. Possible values include: 'Simple', 'Full'
Defines values for RegexFlags. Possible values include: 'CanonEq', 'CaseInsensitive', 'Comments', 'DotAll', 'Literal', 'Multiline', 'UnicodeCase', 'UnixLines'
Options for reset indexer operation.
Options for run indexer operation.
Defines values for ScoringFunctionAggregation. Possible values include: 'Sum', 'Average', 'Minimum', 'Maximum', 'FirstMatching'
Defines values for ScoringFunctionInterpolation. Possible values include: 'Linear', 'Constant', 'Quadratic', 'Logarithmic'
Contains the possible cases for ScoringFunction.
Client options used to configure Cognitive Search API requests.
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)'
Client options used to configure Cognitive Search API requests.
Client options used to configure Cognitive Search API requests.
Defines values for SearchIndexerDataSourceType. Possible values include: 'AzureSql', 'CosmosDb', 'AzureBlob', 'AzureTable', 'MySql'
Contains the possible cases for SearchIndexerSkill.
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.
Defines values for SearchMode. Possible values include: 'Any', 'All'
Defines values for SentimentSkillLanguage. Possible values include: 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'it', 'no', 'pl', 'pt-PT', 'ru', 'es', 'sv', 'tr'
Contains the possible cases for Similarity.
Contains the possible cases for Similarity.
Contains response data for the createOrUpdate operation.
Contains response data for the create operation.
Contains response data for the get operation.
Contains response data for the list operation.
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'
Defines values for SplitSkillLanguage. Possible values include: 'da', 'de', 'en', 'es', 'fi', 'fr', 'it', 'ko', 'pt'
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'
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'
Contains response data for the createOrUpdate operation.
Contains response data for the create operation.
Contains response data for the get operation.
Contains response data for the list operation.
Defines values for TextSplitMode. Possible values include: 'Pages', 'Sentences'
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'
Defines values for TokenCharacterKind. Possible values include: 'Letter', 'Digit', 'Whitespace', 'Punctuation', 'Symbol'
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'
Contains the possible cases for TokenFilter.
Options for the upload documents operation.
Defines values for VisualFeature. Possible values include: 'Adult', 'Brands', 'Categories', 'Description', 'Faces', 'Objects', 'Tags'
The @azure/logger configuration for this package.
Create an HTTP pipeline policy to authenticate a request
using an AzureKeyCredential
for Azure Cognitive Search
Decodes a base64 string into a regular string.
The base64 string to decode.
Encodes a string in base64 format.
The string to encode.
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
Generated using TypeDoc
Options for analyze text operation.