Package version:

@azure/search-documents

Index

Enumerations

KnownAnalyzerNames KnownAzureOpenAIModelName KnownBlobIndexerDataToExtract KnownBlobIndexerImageAction KnownBlobIndexerPDFTextRotationAlgorithm KnownBlobIndexerParsingMode KnownCharFilterNames KnownCustomEntityLookupSkillLanguage KnownEntityCategory KnownEntityRecognitionSkillLanguage KnownImageAnalysisSkillLanguage KnownImageDetail KnownIndexProjectionMode KnownIndexerExecutionEnvironment KnownKeyPhraseExtractionSkillLanguage KnownOcrLineEnding KnownOcrSkillLanguage KnownPIIDetectionSkillMaskingMode KnownRegexFlags KnownSearchAudience KnownSearchFieldDataType KnownSearchIndexerDataSourceType KnownSemanticErrorMode KnownSemanticErrorReason KnownSemanticSearchResultsType KnownSentimentSkillLanguage KnownSplitSkillLanguage KnownTextSplitMode KnownTextTranslationSkillLanguage KnownTokenFilterNames KnownTokenizerNames KnownVectorEncodingFormat KnownVectorFilterMode KnownVectorQueryKind KnownVectorSearchAlgorithmKind KnownVectorSearchAlgorithmMetric KnownVectorSearchCompressionKind KnownVectorSearchCompressionTarget KnownVectorSearchVectorizerKind KnownVisualFeature

Classes

GeographyPoint IndexDocumentsBatch SearchClient SearchIndexClient SearchIndexerClient SearchIndexingBufferedSender

Interfaces

AnalyzeRequest AnalyzeResult AnalyzedTokenInfo AsciiFoldingTokenFilter AutocompleteItem AutocompleteRequest AutocompleteResult AzureActiveDirectoryApplicationCredentials AzureOpenAIEmbeddingSkill AzureOpenAIParameters AzureOpenAIVectorizer BM25Similarity BaseCharFilter BaseCognitiveServicesAccount BaseDataChangeDetectionPolicy BaseDataDeletionDetectionPolicy BaseLexicalAnalyzer BaseLexicalTokenizer BaseScoringFunction BaseSearchIndexerDataIdentity BaseSearchIndexerSkill BaseSearchRequestOptions BaseTokenFilter BaseVectorQuery BaseVectorSearchAlgorithmConfiguration BaseVectorSearchCompression BaseVectorSearchVectorizer BinaryQuantizationCompression CjkBigramTokenFilter ClassicSimilarity ClassicTokenizer CognitiveServicesAccountKey CommonGramTokenFilter ComplexField ConditionalSkill CorsOptions CreateOrUpdateIndexOptions CreateOrUpdateSkillsetOptions CreateOrUpdateSynonymMapOptions CreateorUpdateDataSourceConnectionOptions CreateorUpdateIndexerOptions CustomAnalyzer CustomEntity CustomEntityAlias CustomEntityLookupSkill DefaultCognitiveServicesAccount DeleteDataSourceConnectionOptions DeleteIndexOptions DeleteIndexerOptions DeleteSkillsetOptions DeleteSynonymMapOptions DictionaryDecompounderTokenFilter DistanceScoringFunction DistanceScoringParameters DocumentExtractionSkill EdgeNGramTokenFilter EdgeNGramTokenizer ElisionTokenFilter EntityLinkingSkill EntityRecognitionSkill EntityRecognitionSkillV3 ExhaustiveKnnParameters ExtractiveQueryAnswer ExtractiveQueryCaption FacetResult FieldMapping FieldMappingFunction FreshnessScoringFunction FreshnessScoringParameters GetDocumentOptions HighWaterMarkChangeDetectionPolicy HnswParameters ImageAnalysisSkill IndexDocumentsClient IndexDocumentsOptions IndexDocumentsResult IndexerExecutionResult IndexingParameters IndexingParametersConfiguration IndexingResult IndexingSchedule InputFieldMappingEntry KeepTokenFilter KeyPhraseExtractionSkill KeywordMarkerTokenFilter KeywordTokenizer LanguageDetectionSkill LengthTokenFilter LimitTokenFilter ListSearchResultsPageSettings LuceneStandardAnalyzer LuceneStandardTokenizer MagnitudeScoringFunction MagnitudeScoringParameters MappingCharFilter MergeSkill MicrosoftLanguageStemmingTokenizer MicrosoftLanguageTokenizer NGramTokenFilter NGramTokenizer OcrSkill OutputFieldMappingEntry PIIDetectionSkill PathHierarchyTokenizer PatternAnalyzer PatternCaptureTokenFilter PatternReplaceCharFilter PatternReplaceTokenFilter PatternTokenizer PhoneticTokenFilter QueryAnswerResult QueryCaptionResult ResourceCounter ScalarQuantizationCompression ScalarQuantizationParameters ScoringProfile SearchClientOptions SearchDocumentsPageResult SearchDocumentsResult SearchDocumentsResultBase SearchIndex SearchIndexClientOptions SearchIndexStatistics SearchIndexer SearchIndexerClientOptions SearchIndexerDataContainer SearchIndexerDataNoneIdentity SearchIndexerDataSourceConnection SearchIndexerDataUserAssignedIdentity SearchIndexerError SearchIndexerIndexProjection SearchIndexerIndexProjectionParameters SearchIndexerIndexProjectionSelector SearchIndexerKnowledgeStore SearchIndexerKnowledgeStoreBlobProjectionSelector SearchIndexerKnowledgeStoreFileProjectionSelector SearchIndexerKnowledgeStoreObjectProjectionSelector SearchIndexerKnowledgeStoreParameters SearchIndexerKnowledgeStoreProjection SearchIndexerKnowledgeStoreProjectionSelector SearchIndexerKnowledgeStoreTableProjectionSelector SearchIndexerLimits SearchIndexerSkillset SearchIndexerStatus SearchIndexerWarning SearchIndexingBufferedSenderOptions SearchResourceEncryptionKey SearchServiceStatistics SearchSuggester SemanticConfiguration SemanticField SemanticPrioritizedFields SemanticSearch SemanticSearchOptions SentimentSkill SentimentSkillV3 ServiceCounters ServiceLimits ShaperSkill ShingleTokenFilter Similarity SimpleField SnowballTokenFilter SoftDeleteColumnDeletionDetectionPolicy SplitSkill SqlIntegratedChangeTrackingPolicy StemmerOverrideTokenFilter StemmerTokenFilter StopAnalyzer StopwordsTokenFilter SuggestDocumentsResult SuggestRequest SynonymMap SynonymTokenFilter TagScoringFunction TagScoringParameters TextTranslationSkill TextWeights TruncateTokenFilter UaxUrlEmailTokenizer UniqueTokenFilter VectorSearch VectorSearchOptions VectorSearchProfile VectorizableTextQuery VectorizedQuery WebApiParameters WebApiSkill WebApiVectorizer WordDelimiterTokenFilter

Type Aliases

AnalyzeTextOptions AutocompleteMode AutocompleteOptions AzureOpenAIModelName BlobIndexerDataToExtract BlobIndexerImageAction BlobIndexerPDFTextRotationAlgorithm BlobIndexerParsingMode CharFilter CharFilterName CjkBigramTokenFilterScripts CognitiveServicesAccount ComplexDataType CountDocumentsOptions CreateDataSourceConnectionOptions CreateIndexOptions CreateIndexerOptions CreateSkillsetOptions CreateSynonymMapOptions CustomEntityLookupSkillLanguage DataChangeDetectionPolicy DataDeletionDetectionPolicy DeleteDocumentsOptions EdgeNGramTokenFilterSide EntityCategory EntityRecognitionSkillLanguage ExcludedODataTypes ExhaustiveKnnAlgorithmConfiguration ExtractDocumentKey GetDataSourceConnectionOptions GetIndexOptions GetIndexStatisticsOptions GetIndexerOptions GetIndexerStatusOptions GetServiceStatisticsOptions GetSkillSetOptions GetSynonymMapsOptions HnswAlgorithmConfiguration ImageAnalysisSkillLanguage ImageDetail IndexActionType IndexDocumentsAction IndexIterator IndexNameIterator IndexProjectionMode IndexerExecutionEnvironment IndexerExecutionStatus IndexerStatus KeyPhraseExtractionSkillLanguage LexicalAnalyzer LexicalAnalyzerName LexicalTokenizer LexicalTokenizerName ListDataSourceConnectionsOptions ListIndexersOptions ListIndexesOptions ListSkillsetsOptions ListSynonymMapsOptions MergeDocumentsOptions MergeOrUploadDocumentsOptions MicrosoftStemmingTokenizerLanguage MicrosoftTokenizerLanguage NarrowedModel OcrLineEnding OcrSkillLanguage PIIDetectionSkillMaskingMode PhoneticEncoder QueryAnswer QueryCaption QueryType RegexFlags ResetIndexerOptions RunIndexerOptions ScoringFunction ScoringFunctionAggregation ScoringFunctionInterpolation ScoringStatistics SearchField SearchFieldArray SearchFieldDataType SearchIndexerDataIdentity SearchIndexerDataSourceType SearchIndexerSkill SearchIndexingBufferedSenderDeleteDocumentsOptions SearchIndexingBufferedSenderFlushDocumentsOptions SearchIndexingBufferedSenderMergeDocumentsOptions SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions SearchIndexingBufferedSenderUploadDocumentsOptions SearchIterator SearchMode SearchOptions SearchPick SearchRequestOptions SearchRequestQueryTypeOptions SearchResult SelectArray SelectFields SemanticErrorMode SemanticErrorReason SemanticSearchResultsType SentimentSkillLanguage SimilarityAlgorithm SnowballTokenFilterLanguage SplitSkillLanguage StemmerTokenFilterLanguage StopwordsList SuggestNarrowedModel SuggestOptions SuggestResult TextSplitMode TextTranslationSkillLanguage TokenCharacterKind TokenFilter TokenFilterName UnionToIntersection UploadDocumentsOptions VectorEncodingFormat VectorFilterMode VectorQuery VectorQueryKind VectorSearchAlgorithmConfiguration VectorSearchAlgorithmKind VectorSearchAlgorithmMetric VectorSearchCompression VectorSearchCompressionKind VectorSearchCompressionTarget VectorSearchVectorizer VectorSearchVectorizerKind VisualFeature

Variables

AzureKeyCredential DEFAULT_BATCH_SIZE DEFAULT_FLUSH_WINDOW DEFAULT_RETRY_COUNT

Functions

createSynonymMapFromFile odata

Settings

Member Visibility