Package version:

@azure/search-documents

References

KnownNormalizerNames

Enumerations

KnownAIFoundryModelCatalogName KnownAnalyzerNames KnownAzureOpenAIModelName KnownBlobIndexerDataToExtract KnownBlobIndexerImageAction KnownBlobIndexerParsingMode KnownBlobIndexerPDFTextRotationAlgorithm KnownCharFilterNames KnownChatCompletionExtraParametersBehavior KnownChatCompletionResponseFormatType KnownCustomEntityLookupSkillLanguage KnownDocumentIntelligenceLayoutSkillChunkingUnit KnownDocumentIntelligenceLayoutSkillExtractionOptions KnownDocumentIntelligenceLayoutSkillMarkdownHeaderDepth KnownDocumentIntelligenceLayoutSkillOutputFormat KnownDocumentIntelligenceLayoutSkillOutputMode KnownEntityCategory KnownEntityRecognitionSkillLanguage KnownHybridCountAndFacetMode KnownImageAnalysisSkillLanguage KnownImageDetail KnownIndexerExecutionEnvironment KnownIndexerExecutionStatusDetail KnownIndexerPermissionOption KnownIndexerResyncOption KnownIndexingMode KnownIndexProjectionMode KnownKeyPhraseExtractionSkillLanguage KnownKnowledgeBaseModelKind KnownKnowledgeRetrievalOutputMode KnownKnowledgeSourceKind KnownLexicalAnalyzerName KnownLexicalNormalizerName KnownMarkdownHeaderDepth KnownMarkdownParsingSubmode KnownOcrLineEnding KnownOcrSkillLanguage KnownPermissionFilter KnownPIIDetectionSkillMaskingMode KnownQueryDebugMode KnownQueryLanguage KnownQuerySpeller KnownRankingOrder KnownRegexFlags KnownSearchAudience KnownSearchFieldDataType KnownSearchIndexerDataSourceType KnownSearchIndexPermissionFilterOption KnownSemanticErrorMode KnownSemanticErrorReason KnownSemanticFieldState KnownSemanticQueryRewritesResultType KnownSemanticSearchResultsType KnownSentimentSkillLanguage KnownSplitSkillEncoderModelName KnownSplitSkillLanguage KnownSplitSkillUnit KnownTextSplitMode KnownTextTranslationSkillLanguage KnownTokenFilterNames KnownTokenizerNames KnownVectorEncodingFormat KnownVectorFilterMode KnownVectorQueryKind KnownVectorSearchAlgorithmKind KnownVectorSearchAlgorithmMetric KnownVectorSearchCompressionKind KnownVectorSearchCompressionRescoreStorageMethod KnownVectorSearchCompressionTarget KnownVectorSearchVectorizerKind KnownVectorThresholdKind KnownVisualFeature

Classes

GeographyPoint IndexDocumentsBatch KnowledgeRetrievalClient SearchClient SearchIndexClient SearchIndexerClient SearchIndexingBufferedSender

Interfaces

AIServices AIServicesAccountIdentity AIServicesAccountKey AIServicesVisionParameters AIServicesVisionVectorizer AnalyzedTokenInfo AnalyzeRequest AnalyzeResult AsciiFoldingTokenFilter AutocompleteItem AutocompleteRequest AutocompleteResult AzureActiveDirectoryApplicationCredentials AzureBlobKnowledgeSource AzureBlobKnowledgeSourceParameters AzureBlobKnowledgeSourceParams AzureMachineLearningSkill AzureMachineLearningVectorizer AzureOpenAIEmbeddingSkill AzureOpenAIParameters AzureOpenAITokenizerParameters AzureOpenAIVectorizer BaseAzureMachineLearningVectorizerParameters BaseCharFilter BaseCognitiveServicesAccount BaseDataChangeDetectionPolicy BaseDataDeletionDetectionPolicy BaseKnowledgeBaseActivityRecord BaseKnowledgeBaseMessageContent BaseKnowledgeBaseModel BaseKnowledgeBaseReference BaseKnowledgeBaseRetrievalActivityRecord BaseKnowledgeRetrievalReasoningEffort BaseKnowledgeSource BaseKnowledgeSourceParams BaseKnowledgeSourceVectorizer BaseLexicalAnalyzer BaseLexicalNormalizer BaseLexicalTokenizer BaseScoringFunction BaseSearchIndexerDataIdentity BaseSearchIndexerSkill BaseSearchRequestOptions BaseTokenFilter BaseVectorQuery BaseVectorSearchAlgorithmConfiguration BaseVectorSearchCompression BaseVectorSearchVectorizer BaseVectorThreshold BinaryQuantizationCompression BM25Similarity ChatCompletionResponseFormat ChatCompletionResponseFormatJsonSchemaProperties ChatCompletionSchema ChatCompletionSkill CjkBigramTokenFilter ClassicSimilarity ClassicTokenizer CognitiveServicesAccountKey CommonGramTokenFilter CommonModelParameters CompletedSynchronizationState ComplexField ConditionalSkill ContentUnderstandingSkill ContentUnderstandingSkillChunkingProperties CorsOptions CreateKnowledgeBaseOptions CreateKnowledgeSourceOptions CreateOrUpdateAliasOptions CreateorUpdateDataSourceConnectionOptions CreateorUpdateIndexerOptions CreateOrUpdateIndexOptions CreateOrUpdateKnowledgeBaseOptions CreateOrUpdateKnowledgeSourceOptions CreateOrUpdateSkillsetOptions CreateOrUpdateSynonymMapOptions CustomAnalyzer CustomEntity CustomEntityAlias CustomEntityLookupSkill CustomNormalizer DebugInfo DefaultCognitiveServicesAccount DeleteAliasOptions DeleteDataSourceConnectionOptions DeleteIndexerOptions DeleteIndexOptions DeleteKnowledgeBaseOptions DeleteKnowledgeSourceOptions DeleteSkillsetOptions DeleteSynonymMapOptions DictionaryDecompounderTokenFilter DistanceScoringFunction DistanceScoringParameters DocumentDebugInfo DocumentExtractionSkill DocumentIntelligenceLayoutSkill DocumentIntelligenceLayoutSkillChunkingProperties EdgeNGramTokenFilter EdgeNGramTokenizer ElisionTokenFilter EntityLinkingSkill EntityRecognitionSkill EntityRecognitionSkillV3 ExhaustiveKnnParameters ExtractiveQueryAnswer ExtractiveQueryCaption FacetResult FieldMapping FieldMappingFunction FreshnessScoringFunction FreshnessScoringParameters GenerativeQueryRewrites GetDocumentOptions GetIndexStatsSummaryOptionalParams GetIndexStatsSummaryOptions GetKnowledgeBaseOptions GetKnowledgeSourceOptions GetKnowledgeSourceStatusOptions HighWaterMarkChangeDetectionPolicy HnswParameters HybridSearchOptions ImageAnalysisSkill IndexDocumentsClient IndexDocumentsOptions IndexDocumentsResult IndexedOneLakeKnowledgeSource IndexedOneLakeKnowledgeSourceParameters IndexedOneLakeKnowledgeSourceParams IndexedSharePointKnowledgeSource IndexedSharePointKnowledgeSourceParameters IndexedSharePointKnowledgeSourceParams IndexerExecutionResult IndexerRuntime IndexersResyncOptionalParams IndexerState IndexingParameters IndexingParametersConfiguration IndexingResult IndexingSchedule IndexStatisticsSummary InputFieldMappingEntry KeepTokenFilter KeyAuthAzureMachineLearningVectorizerParameters KeyPhraseExtractionSkill KeywordMarkerTokenFilter KeywordTokenizer KnowledgeBase KnowledgeBaseAgenticReasoningActivityRecord KnowledgeBaseAzureBlobActivityArguments KnowledgeBaseAzureBlobActivityRecord KnowledgeBaseAzureBlobReference KnowledgeBaseAzureOpenAIModel KnowledgeBaseErrorAdditionalInfo KnowledgeBaseErrorDetail KnowledgeBaseIndexedOneLakeActivityArguments KnowledgeBaseIndexedOneLakeActivityRecord KnowledgeBaseIndexedOneLakeReference KnowledgeBaseIndexedSharePointActivityArguments KnowledgeBaseIndexedSharePointActivityRecord KnowledgeBaseIndexedSharePointReference KnowledgeBaseMessage KnowledgeBaseMessageImageContent KnowledgeBaseMessageImageContentImage KnowledgeBaseMessageTextContent KnowledgeBaseModelAnswerSynthesisActivityRecord KnowledgeBaseModelQueryPlanningActivityRecord KnowledgeBaseRemoteSharePointActivityArguments KnowledgeBaseRemoteSharePointActivityRecord KnowledgeBaseRemoteSharePointReference KnowledgeBaseRetrievalRequest KnowledgeBaseRetrievalResponse KnowledgeBaseSearchIndexActivityArguments KnowledgeBaseSearchIndexActivityRecord KnowledgeBaseSearchIndexFieldReference KnowledgeBaseSearchIndexReference KnowledgeBaseWebActivityArguments KnowledgeBaseWebActivityRecord KnowledgeBaseWebReference KnowledgeRetrievalClientOptions KnowledgeRetrievalIntent KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort KnowledgeRetrievalReasoningEffort KnowledgeRetrievalSemanticIntent KnowledgeSourceAzureOpenAIVectorizer KnowledgeSourceIngestionParameters KnowledgeSourceReference KnowledgeSourceStatistics KnowledgeSourceStatus LanguageDetectionSkill LengthTokenFilter LimitTokenFilter ListIndexStatsSummary ListKnowledgeBasesOptions ListKnowledgeSourcesOptions ListSearchResultsPageSettings LuceneStandardAnalyzer LuceneStandardTokenizer MagnitudeScoringFunction MagnitudeScoringParameters MappingCharFilter MergeSkill MicrosoftLanguageStemmingTokenizer MicrosoftLanguageTokenizer NativeBlobSoftDeleteDeletionDetectionPolicy NGramTokenFilter NGramTokenizer NoAuthAzureMachineLearningVectorizerParameters OcrSkill OutputFieldMappingEntry PathHierarchyTokenizer PatternAnalyzer PatternCaptureTokenFilter PatternReplaceCharFilter PatternReplaceTokenFilter PatternTokenizer PhoneticTokenFilter PIIDetectionSkill QueryAnswerResult QueryCaptionResult QueryResultDocumentInnerHit QueryResultDocumentRerankerInput QueryResultDocumentSemanticField QueryResultDocumentSubscores QueryRewritesDebugInfo QueryRewritesValuesDebugInfo RemoteSharePointKnowledgeSource RemoteSharePointKnowledgeSourceParameters RemoteSharePointKnowledgeSourceParams RescoringOptions ResetDocumentsOptions ResetSkillsOptions ResourceCounter RetrieveKnowledgeOptions ScalarQuantizationCompression ScalarQuantizationParameters ScoringProfile SearchAlias SearchClientOptions SearchDocumentsPageResult SearchDocumentsResult SearchDocumentsResultBase SearchIndex SearchIndexClientOptions SearchIndexer SearchIndexerCache SearchIndexerClientOptions SearchIndexerDataContainer SearchIndexerDataNoneIdentity SearchIndexerDataSourceConnection SearchIndexerDataUserAssignedIdentity SearchIndexerError SearchIndexerIndexProjection SearchIndexerIndexProjectionParameters SearchIndexerIndexProjectionSelector SearchIndexerKnowledgeStore SearchIndexerKnowledgeStoreBlobProjectionSelector SearchIndexerKnowledgeStoreFileProjectionSelector SearchIndexerKnowledgeStoreObjectProjectionSelector SearchIndexerKnowledgeStoreParameters SearchIndexerKnowledgeStoreProjection SearchIndexerKnowledgeStoreProjectionSelector SearchIndexerKnowledgeStoreTableProjectionSelector SearchIndexerLimits SearchIndexerSkillset SearchIndexerStatus SearchIndexerWarning SearchIndexFieldReference SearchIndexingBufferedSenderOptions SearchIndexKnowledgeSource SearchIndexKnowledgeSourceParameters SearchIndexKnowledgeSourceParams SearchIndexStatistics SearchResourceEncryptionKey SearchScoreThreshold SearchServiceStatistics SearchSuggester SemanticConfiguration SemanticDebugInfo SemanticField SemanticPrioritizedFields SemanticSearch SemanticSearchOptions SentimentSkill SentimentSkillV3 ServiceCounters ServiceLimits ShaperSkill SharePointSensitivityLabelInfo ShingleTokenFilter Similarity SimpleField SingleVectorFieldResult SnowballTokenFilter SoftDeleteColumnDeletionDetectionPolicy SplitSkill SqlIntegratedChangeTrackingPolicy StemmerOverrideTokenFilter StemmerTokenFilter StopAnalyzer StopwordsTokenFilter SuggestDocumentsResult SuggestRequest SynchronizationState SynonymMap SynonymTokenFilter TagScoringFunction TagScoringParameters TextResult TextTranslationSkill TextWeights TokenAuthAzureMachineLearningVectorizerParameters TruncateTokenFilter UaxUrlEmailTokenizer UniqueTokenFilter VectorizableImageBinaryQuery VectorizableImageUrlQuery VectorizableTextQuery VectorizedQuery VectorsDebugInfo VectorSearch VectorSearchOptions VectorSearchProfile VectorSimilarityThreshold VisionVectorizeSkill WebApiParameters WebApiSkill WebApiVectorizer WebKnowledgeSource WebKnowledgeSourceDomain WebKnowledgeSourceDomains WebKnowledgeSourceParameters WebKnowledgeSourceParams WordDelimiterTokenFilter

Type Aliases

AIFoundryModelCatalogName AliasIterator AnalyzeTextOptions AutocompleteMode AutocompleteOptions AzureMachineLearningVectorizerParameters AzureOpenAIModelName BaseKnowledgeRetrievalIntent BaseKnowledgeRetrievalOutputMode BlobIndexerDataToExtract BlobIndexerImageAction BlobIndexerParsingMode BlobIndexerPDFTextRotationAlgorithm CharFilter CharFilterName ChatCompletionExtraParametersBehavior ChatCompletionResponseFormatType CjkBigramTokenFilterScripts CognitiveServicesAccount ComplexDataType ContentUnderstandingSkillChunkingUnit ContentUnderstandingSkillExtractionOptions CountDocumentsOptions CreateAliasOptions CreateDataSourceConnectionOptions CreateIndexerOptions CreateIndexOptions CreateSkillsetOptions CreateSynonymMapOptions CustomEntityLookupSkillLanguage DataChangeDetectionPolicy DataDeletionDetectionPolicy DeleteDocumentsOptions DocumentIntelligenceLayoutSkillChunkingUnit DocumentIntelligenceLayoutSkillExtractionOptions DocumentIntelligenceLayoutSkillMarkdownHeaderDepth DocumentIntelligenceLayoutSkillOutputFormat DocumentIntelligenceLayoutSkillOutputMode EdgeNGramTokenFilterSide EntityCategory EntityRecognitionSkillLanguage ExcludedODataTypes ExhaustiveKnnAlgorithmConfiguration ExtractDocumentKey GetAliasOptions GetDataSourceConnectionOptions GetIndexerOptions GetIndexerStatusOptions GetIndexOptions GetIndexStatisticsOptions GetIndexStatsSummaryResponse GetServiceStatisticsOptions GetSkillSetOptions GetSynonymMapsOptions HnswAlgorithmConfiguration HybridCountAndFacetMode ImageAnalysisSkillLanguage ImageDetail IndexActionType IndexDocumentsAction IndexedSharePointContainerName IndexerExecutionEnvironment IndexerExecutionStatus IndexerExecutionStatusDetail IndexerPermissionOption IndexerResyncOption IndexerStatus IndexingMode IndexIterator IndexNameIterator IndexProjectionMode IndexStatisticsSummaryIterator KeyPhraseExtractionSkillLanguage KnowledgeBaseActivityRecord KnowledgeBaseIterator KnowledgeBaseMessageContent KnowledgeBaseModel KnowledgeBaseReference KnowledgeBaseRetrievalActivityRecord KnowledgeRetrievalOutputMode KnowledgeRetrievalReasoningEffortUnion KnowledgeSource KnowledgeSourceContentExtractionMode KnowledgeSourceIngestionPermissionOption KnowledgeSourceIterator KnowledgeSourceKind KnowledgeSourceParams KnowledgeSourceSynchronizationStatus KnowledgeSourceVectorizer LexicalAnalyzer LexicalAnalyzerName LexicalNormalizer LexicalNormalizerName LexicalTokenizer LexicalTokenizerName ListAliasesOptions ListDataSourceConnectionsOptions ListIndexersOptions ListIndexesOptions ListSkillsetsOptions ListSynonymMapsOptions MarkdownHeaderDepth MarkdownParsingSubmode MergeDocumentsOptions MergeOrUploadDocumentsOptions MicrosoftStemmingTokenizerLanguage MicrosoftTokenizerLanguage NarrowedModel OcrLineEnding OcrSkillLanguage PermissionFilter PhoneticEncoder PIIDetectionSkillMaskingMode QueryAnswer QueryCaption QueryDebugMode QueryLanguage QueryRewrites QuerySpeller QueryType RankingOrder RegexFlags ResetIndexerOptions RunIndexerOptions ScoringFunction ScoringFunctionAggregation ScoringFunctionInterpolation ScoringStatistics SearchField SearchFieldArray SearchFieldDataType SearchIndexAlias SearchIndexerDataIdentity SearchIndexerDataSourceType SearchIndexerSkill SearchIndexingBufferedSenderDeleteDocumentsOptions SearchIndexingBufferedSenderFlushDocumentsOptions SearchIndexingBufferedSenderMergeDocumentsOptions SearchIndexingBufferedSenderMergeOrUploadDocumentsOptions SearchIndexingBufferedSenderUploadDocumentsOptions SearchIndexPermissionFilterOption SearchIterator SearchMode SearchOptions SearchPick SearchRequestOptions SearchRequestQueryTypeOptions SearchResult SelectArray SelectFields SemanticErrorMode SemanticErrorReason SemanticFieldState SemanticQueryRewritesResultType SemanticSearchResultsType SentimentSkillLanguage SimilarityAlgorithm SnowballTokenFilterLanguage SplitSkillEncoderModelName SplitSkillLanguage SplitSkillUnit StemmerTokenFilterLanguage StopwordsList SuggestNarrowedModel SuggestOptions SuggestResult TextSplitMode TextTranslationSkillLanguage TokenCharacterKind TokenFilter TokenFilterName UnionToIntersection UploadDocumentsOptions VectorEncodingFormat VectorFilterMode VectorQuery VectorQueryKind VectorSearchAlgorithmConfiguration VectorSearchAlgorithmKind VectorSearchAlgorithmMetric VectorSearchCompression VectorSearchCompressionKind VectorSearchCompressionRescoreStorageMethod VectorSearchCompressionTarget VectorSearchVectorizer VectorSearchVectorizerKind VectorThreshold VisualFeature WebApiSkills

Variables

AzureKeyCredential DEFAULT_BATCH_SIZE DEFAULT_FLUSH_WINDOW DEFAULT_RETRY_COUNT

Functions

createSynonymMapFromFile odata

References

KnownNormalizerNames

Renames and re-exports KnownLexicalNormalizerName

Settings

Member Visibility

On This Page

References