|
AIServices(Uri, String)
|
Parameters for AI Services.
|
|
AIServicesAccountIdentity(String, SearchIndexerDataIdentity, Uri)
|
The multi-region account of an Azure AI service resource that's attached to a skillset.
|
|
AIServicesAccountKey(String, String, String)
|
The account key of an Azure AI service resource that's attached to a skillset, to be used with the resource's subdomain.
|
|
AnalyzedTokenInfo(String, Int32, Int32, Int32)
|
Initializes a new instance of AnalyzedTokenInfo.
|
|
AnalyzeTextOptions(String, Nullable<LexicalAnalyzerName>, Nullable<LexicalTokenizerName>,
Nullable<LexicalNormalizerName>, IEnumerable<TokenFilterName>,
IEnumerable<String>)
|
Specifies some text and analysis components used to break that text into tokens.
|
|
AsciiFoldingTokenFilter(String, Nullable<Boolean>)
|
Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.
|
|
AutocompleteItem(String, String)
|
Initializes a new instance of AutocompleteItem.
|
|
AutocompleteOptions(String, Nullable<AutocompleteMode>, String, Nullable<Boolean>, String, String, Nullable<Double>, String, String, Nullable<Int32>)
|
The AutocompleteOptions.
|
|
AutocompleteResults(Nullable<Double>, IEnumerable<AutocompleteItem>)
|
The result of Autocomplete query.
|
|
AzureBlobKnowledgeSource(String, String, Nullable<ETag>, SearchResourceEncryptionKey, AzureBlobKnowledgeSourceParameters)
|
Configuration for Azure Blob Storage knowledge source.
|
|
AzureBlobKnowledgeSource(String, String, String, String, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>, AzureBlobKnowledgeSourceParameters)
|
Initializes a new instance of AzureBlobKnowledgeSource(String, String, String, String, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>, AzureBlobKnowledgeSourceParameters).
|
|
AzureBlobKnowledgeSourceParameters(String, String, String, Nullable<Boolean>, KnowledgeSourceIngestionParameters, CreatedResources)
|
Parameters for Azure Blob Storage knowledge source.
|
|
AzureBlobKnowledgeSourceParameters(String, String, String, Nullable<Boolean>, KnowledgeSourceIngestionParameters, IReadOnlyDictionary<String,String>)
|
Initializes a new instance of AzureBlobKnowledgeSourceParameters.
|
|
AzureBlobKnowledgeSourceParams(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>)
|
Specifies runtime parameters for a azure blob knowledge source.
|
|
AzureMachineLearningParameters(Uri, String, String, Nullable<TimeSpan>, String, Nullable<AIFoundryModelCatalogName>)
|
Specifies the properties for connecting to an AML vectorizer.
|
|
AzureMachineLearningVectorizer(String, AzureMachineLearningParameters)
|
Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog for generating the vector embedding of a query string.
|
|
AzureOpenAIEmbeddingSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Uri, String, String, SearchIndexerDataIdentity,
Nullable<AzureOpenAIModelName>, Nullable<Int32>)
|
Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource.
|
|
AzureOpenAIVectorizer(String, AzureOpenAIVectorizerParameters)
|
Specifies the Azure OpenAI resource used to vectorize a query string.
|
|
AzureOpenAIVectorizerParameters(Uri, String, String, SearchIndexerDataIdentity, Nullable<AzureOpenAIModelName>)
|
Specifies the parameters for connecting to the Azure OpenAI resource.
|
|
BinaryQuantizationCompression(String, RescoringOptions, Nullable<Int32>)
|
Contains configuration options specific to the binary quantization compression method used during indexing and querying.
|
|
BM25Similarity(Nullable<Double>, Nullable<Double>)
|
Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter).
|
|
CharFilter(String, String)
|
Initializes a new instance of CharFilter.
|
|
ChatCompletionCommonModelParameters(String, Nullable<Double>,
Nullable<Double>, Nullable<Int32>, Nullable<Double>, Nullable<Int32>,
IEnumerable<String>)
|
Common language model parameters for Chat Completions. If omitted, default values are used.
|
|
ChatCompletionResponseFormat(Nullable<ChatCompletionResponseFormatType>, ChatCompletionSchemaProperties)
|
Determines how the language model's response should be serialized. Defaults to 'text'.
|
|
ChatCompletionSchema(String, String, IEnumerable<String>, Nullable<Boolean>)
|
Object defining the custom schema the model will use to structure its output.
|
|
ChatCompletionSchemaProperties(String, String, Nullable<Boolean>, ChatCompletionSchema)
|
Properties for JSON schema response format.
|
|
ChatCompletionSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Uri, SearchIndexerDataIdentity,
String, ChatCompletionCommonModelParameters, IDictionary<String,
BinaryData>, Nullable<ChatCompletionExtraParametersBehavior>,
ChatCompletionResponseFormat)
|
A skill that calls a language model via Azure AI Foundry's Chat Completions endpoint.
|
|
CjkBigramTokenFilter(String, IEnumerable<CjkBigramTokenFilterScripts>, Nullable<Boolean>)
|
Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.
|
|
ClassicSimilarity()
|
Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries.
|
|
ClassicTokenizer(String, Nullable<Int32>)
|
Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.
|
|
CognitiveServicesAccount(String, String)
|
Initializes a new instance of CognitiveServicesAccount.
|
|
CognitiveServicesAccountKey(String, String)
|
The multi-region account key of an Azure AI service resource that's attached to a skillset.
|
|
CommonGramTokenFilter(String, IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>)
|
Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.
|
|
CompletedSynchronizationState(DateTimeOffset, DateTimeOffset, Int32, Int32, Int32)
|
Represents the completed state of the last synchronization.
|
|
ConditionalSkill(String, String, String, IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>)
|
A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output.
|
|
ContentUnderstandingSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, IEnumerable<ContentUnderstandingSkillExtractionOptions>,
ContentUnderstandingSkillChunkingProperties)
|
A skill that leverages Azure AI Content Understanding to process and extract structured insights from documents, enabling enriched, searchable content for enhanced document indexing and retrieval.
|
|
ContentUnderstandingSkillChunkingProperties(Nullable<ContentUnderstandingSkillChunkingUnit>, Nullable<Int32>, Nullable<Int32>)
|
Controls the cardinality for chunking the content.
|
|
CorsOptions(IEnumerable<String>, Nullable<Int64>)
|
Defines options to control Cross-Origin Resource Sharing (CORS) for an index.
|
|
CreatedResources(IReadOnlyDictionary<String,String>)
|
Resources created by the knowledge source. Keys represent resource types (e.g., 'datasource', 'indexer', 'skillset', 'index') and values represent resource names.
|
|
CustomAnalyzer(String, LexicalTokenizerName, IEnumerable<TokenFilterName>, IEnumerable<String>)
|
Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer.
|
|
CustomEntity(String, String, String, String, String, Nullable<Boolean>,
Nullable<Boolean>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>,
Nullable<Int32>, IEnumerable<CustomEntityAlias>)
|
An object that contains information about the matches that were found, and related metadata.
|
|
CustomEntityAlias(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Int32>)
|
A complex object that can be used to specify alternative spellings or synonyms to the root entity name.
|
|
CustomEntityLookupSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<CustomEntityLookupSkillLanguage>,
Uri, IEnumerable<CustomEntity>, Nullable<Boolean>, Nullable<Boolean>,
Nullable<Int32>)
|
A skill looks for text from a custom, user-defined list of words and phrases.
|
|
CustomNormalizer(String, IEnumerable<TokenFilterName>, IEnumerable<CharFilterName>)
|
Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.
|
|
DataChangeDetectionPolicy(String)
|
Initializes a new instance of DataChangeDetectionPolicy.
|
|
DataDeletionDetectionPolicy(String)
|
Initializes a new instance of DataDeletionDetectionPolicy.
|
|
DebugInfo(QueryRewritesDebugInfo)
|
Initializes a new instance of DebugInfo.
|
|
DefaultCognitiveServicesAccount(String)
|
An empty object that represents the default Azure AI service resource for a skillset.
|
|
DictionaryDecompounderTokenFilter(String, IEnumerable<String>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>)
|
Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.
|
|
DistanceScoringFunction(String, Double, Nullable<ScoringFunctionInterpolation>, DistanceScoringParameters)
|
Defines a function that boosts scores based on distance from a geographic location.
|
|
DistanceScoringParameters(String, Double)
|
Provides parameter values to a distance scoring function.
|
|
DocumentDebugInfo(SemanticDebugInfo, VectorsDebugInfo, IReadOnlyDictionary<String,IList<QueryResultDocumentInnerHit>>)
|
Initializes a new instance of DocumentDebugInfo.
|
|
DocumentExtractionSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<BlobIndexerParsingMode>,
Nullable<BlobIndexerDataToExtract>, IDictionary<String,Object>)
|
A skill that extracts content from a file within the enrichment pipeline.
|
|
DocumentIntelligenceLayoutSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<DocumentIntelligenceLayoutSkillOutputFormat>,
Nullable<DocumentIntelligenceLayoutSkillOutputMode>, Nullable<DocumentIntelligenceLayoutSkillMarkdownHeaderDepth>,
IEnumerable<DocumentIntelligenceLayoutSkillExtractionOptions>,
DocumentIntelligenceLayoutSkillChunkingProperties)
|
A skill that extracts content and layout information, via Azure AI Services, from files within the enrichment pipeline.
|
|
DocumentIntelligenceLayoutSkillChunkingProperties(Nullable<DocumentIntelligenceLayoutSkillChunkingUnit>, Nullable<Int32>, Nullable<Int32>)
|
Controls the cardinality for chunking the content.
|
|
EdgeNGramTokenizer(String, Nullable<Int32>, Nullable<Int32>, IEnumerable<TokenCharacterKind>)
|
Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.
|
|
ElisionTokenFilter(String, IEnumerable<String>)
|
Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). This token filter is implemented using Apache Lucene.
|
|
EntityLinkingSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, String, Nullable<Double>,
String)
|
Using the Text Analytics API, extracts linked entities from text.
|
|
EntityRecognitionSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, IEnumerable<EntityCategory>,
Nullable<EntityRecognitionSkillLanguage>, Nullable<Double>, String)
|
Using the Text Analytics API, extracts entities of different types from text.
|
|
ExhaustiveKnnAlgorithmConfiguration(String, ExhaustiveKnnParameters)
|
Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index.
|
|
ExhaustiveKnnParameters(Nullable<VectorSearchAlgorithmMetric>)
|
Contains the parameters specific to exhaustive KNN algorithm.
|
|
FacetResult(Nullable<Int64>, IDictionary<String,BinaryData>)
|
A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval.
|
|
FacetResult(Nullable<Int64>, Nullable<Double>, Nullable<Double>,
Nullable<Double>, Nullable<Double>, Nullable<Int64>, IReadOnlyDictionary<String,
IList<FacetResult>>, IReadOnlyDictionary<String,Object>)
|
Initializes a new instance of FacetResult.
|
|
FieldMapping(String, String, FieldMappingFunction)
|
Defines a mapping between a field in a data source and a target field in an index.
|
|
FieldMappingFunction(String, IDictionary<String,Object>)
|
Represents a function that transforms a value from a data source before indexing.
|
|
FreshnessScoringFunction(String, Double, Nullable<ScoringFunctionInterpolation>, FreshnessScoringParameters)
|
Defines a function that boosts scores based on the value of a date-time field.
|
|
FreshnessScoringParameters(TimeSpan)
|
Provides parameter values to a freshness scoring function.
|
|
HighWaterMarkChangeDetectionPolicy(String)
|
Defines a data change detection policy that captures changes based on the value of a high water mark column.
|
|
HnswAlgorithmConfiguration(String, HnswParameters)
|
Contains configuration options specific to the HNSW approximate nearest neighbors algorithm used during indexing and querying. The HNSW algorithm offers a tunable trade-off between search speed and accuracy.
|
|
HnswParameters(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<VectorSearchAlgorithmMetric>)
|
Contains the parameters specific to the HNSW algorithm.
|
|
ImageAnalysisSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<ImageAnalysisSkillLanguage>,
IEnumerable<VisualFeature>, IEnumerable<ImageDetail>)
|
A skill that analyzes image files. It extracts a rich set of visual features based on the image content.
|
|
IndexDocumentsResult(IEnumerable<IndexingResult>)
|
Initializes a new instance of IndexDocumentsResult.
|
|
IndexedOneLakeKnowledgeSource(String, String, Nullable<ETag>, SearchResourceEncryptionKey, IndexedOneLakeKnowledgeSourceParameters)
|
Configuration for OneLake knowledge source.
|
|
IndexedOneLakeKnowledgeSourceParameters(String, String, String, KnowledgeSourceIngestionParameters, CreatedResources)
|
Parameters for OneLake knowledge source.
|
|
IndexedOneLakeKnowledgeSourceParameters(String, String, String, KnowledgeSourceIngestionParameters, IReadOnlyDictionary<String,String>)
|
Initializes a new instance of IndexedOneLakeKnowledgeSourceParameters.
|
|
IndexedOneLakeKnowledgeSourceParams(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>)
|
Specifies runtime parameters for a indexed OneLake knowledge source.
|
|
IndexedSharePointKnowledgeSourceParameters(String, IndexedSharePointContainerName,
String, KnowledgeSourceIngestionParameters, IReadOnlyDictionary<String,
String>)
|
Initializes a new instance of IndexedSharePointKnowledgeSourceParameters.
|
|
IndexerChangeTrackingState(String, String, String, String)
|
Initializes a new instance of the IndexerChangeTrackingState(String, String, String, String) class.
|
|
IndexerExecutionResult(IndexerExecutionStatus, Nullable<IndexerExecutionStatusDetail>,
Nullable<IndexingMode>, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>,
IEnumerable<SearchIndexerError>, IEnumerable<SearchIndexerWarning>,
Int32, Int32, String, String)
|
Initializes a new instance of IndexerExecutionResult.
|
|
IndexerRuntime(Int64, Nullable<Int64>, DateTimeOffset, DateTimeOffset)
|
Initializes a new instance of IndexerRuntime.
|
|
IndexerState(Nullable<IndexingMode>, String, String, String, String, IEnumerable<String>, IEnumerable<String>, String, String)
|
Initializes a new instance of IndexerState.
|
|
IndexerState(Nullable<IndexingMode>, String, String, String, String, IEnumerable<String>, IEnumerable<String>)
|
Initializes a new instance of IndexerState.
|
|
IndexingParameters(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IndexingParametersConfiguration)
|
Represents parameters for indexer execution.
|
|
IndexingParametersConfiguration(Nullable<BlobIndexerParsingMode>,
String, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>,
String, String, Nullable<Boolean>, Nullable<MarkdownParsingSubmode>,
Nullable<MarkdownHeaderDepth>, String, Nullable<BlobIndexerDataToExtract>,
Nullable<BlobIndexerImageAction>, Nullable<Boolean>, Nullable<BlobIndexerPdfTextRotationAlgorithm>,
Nullable<IndexerExecutionEnvironment>, String, IDictionary<String,
BinaryData>)
|
A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
|
|
IndexingResult(String, String, Boolean, Int32)
|
Initializes a new instance of IndexingResult.
|
|
IndexingSchedule(TimeSpan, Nullable<DateTimeOffset>)
|
Represents a schedule for indexer execution.
|
|
IndexStatisticsSummary(String, Int64, Int64, Int64)
|
Initializes a new instance of IndexStatisticsSummary.
|
|
InputFieldMappingEntry(String, String, String, IEnumerable<InputFieldMappingEntry>)
|
Input field mapping for a skill.
|
|
KeepTokenFilter(String, IEnumerable<String>, Nullable<Boolean>)
|
A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.
|
|
KeyPhraseExtractionSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<KeyPhraseExtractionSkillLanguage>,
Nullable<Int32>, String)
|
A skill that uses text analytics for key phrase extraction.
|
|
KeywordMarkerTokenFilter(String, IEnumerable<String>, Nullable<Boolean>)
|
Marks terms as keywords. This token filter is implemented using Apache Lucene.
|
|
KeywordTokenizer(String, Nullable<Int32>)
|
Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.
|
|
KnowledgeBase(String, IEnumerable<KnowledgeSourceReference>, IEnumerable<KnowledgeBaseModel>,
KnowledgeRetrievalReasoningEffort, Nullable<KnowledgeRetrievalOutputMode>,
String, SearchResourceEncryptionKey, String, String, String,
IDictionary<String,BinaryData>)
|
Initializes a new instance of KnowledgeBase(String, IEnumerable<KnowledgeSourceReference>, IEnumerable<KnowledgeBaseModel>,
KnowledgeRetrievalReasoningEffort, Nullable<KnowledgeRetrievalOutputMode>,
String, SearchResourceEncryptionKey, String, String, String,
IDictionary<String,BinaryData>).
|
|
KnowledgeBase(String, IEnumerable<KnowledgeSourceReference>, IEnumerable<KnowledgeBaseModel>, Nullable<ETag>, SearchResourceEncryptionKey, String)
|
Represents a knowledge base definition.
|
|
KnowledgeBaseActivityRecord(Int32, String, Nullable<Int32>, KnowledgeBaseErrorDetail)
|
Base type for activity records. Tracks execution details, timing, and errors for knowledge base operations.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseModelWebSummarizationActivityRecord and KnowledgeBaseAgenticReasoningActivityRecord.
|
|
KnowledgeBaseAgenticReasoningActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail, Nullable<Int32>, KnowledgeRetrievalReasoningEffort)
|
Represents an agentic reasoning activity record.
|
|
KnowledgeBaseAzureBlobActivityArguments(String)
|
Initializes a new instance of KnowledgeBaseAzureBlobActivityArguments.
|
|
KnowledgeBaseAzureBlobActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail,
String, Nullable<DateTimeOffset>, Nullable<Int32>, KnowledgeBaseAzureBlobActivityArguments)
|
Initializes a new instance of KnowledgeBaseAzureBlobActivityRecord.
|
|
KnowledgeBaseAzureBlobReference(String, Int32, IDictionary<String,BinaryData>, Nullable<Single>, Uri)
|
Represents an Azure Blob Storage document reference.
|
|
KnowledgeBaseAzureBlobReference(String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>, String)
|
Initializes a new instance of KnowledgeBaseAzureBlobReference.
|
|
KnowledgeBaseAzureOpenAIModel(AzureOpenAIVectorizerParameters)
|
Specifies the Azure OpenAI resource used to do query planning.
|
|
KnowledgeBaseErrorAdditionalInfo(String, IReadOnlyDictionary<String,BinaryData>)
|
The resource management error additional info.
|
|
KnowledgeBaseErrorAdditionalInfo(String, Object)
|
Initializes a new instance of KnowledgeBaseErrorAdditionalInfo.
|
|
KnowledgeBaseErrorDetail(String, String, String, IEnumerable<KnowledgeBaseErrorDetail>, IEnumerable<KnowledgeBaseErrorAdditionalInfo>)
|
The error details.
|
|
KnowledgeBaseImageContent(Uri)
|
Image content.
|
|
KnowledgeBaseIndexedOneLakeActivityArguments(String)
|
Initializes a new instance of KnowledgeBaseIndexedOneLakeActivityArguments.
|
|
KnowledgeBaseIndexedOneLakeActivityRecord(Int32, Nullable<Int32>,
KnowledgeBaseErrorDetail, String, Nullable<DateTimeOffset>, Nullable<Int32>,
KnowledgeBaseIndexedOneLakeActivityArguments)
|
Initializes a new instance of KnowledgeBaseIndexedOneLakeActivityRecord.
|
|
KnowledgeBaseIndexedOneLakeReference(String, Int32, IDictionary<String,BinaryData>, Nullable<Single>, Uri)
|
Represents an indexed OneLake document reference.
|
|
KnowledgeBaseIndexedOneLakeReference(String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>, String)
|
Initializes a new instance of KnowledgeBaseIndexedOneLakeReference.
|
|
KnowledgeBaseIndexedSharePointActivityArguments(String)
|
Initializes a new instance of KnowledgeBaseIndexedSharePointActivityArguments.
|
|
KnowledgeBaseIndexedSharePointActivityRecord(Int32, Nullable<Int32>,
KnowledgeBaseErrorDetail, String, Nullable<DateTimeOffset>, Nullable<Int32>,
KnowledgeBaseIndexedSharePointActivityArguments)
|
Initializes a new instance of KnowledgeBaseIndexedSharePointActivityRecord.
|
|
KnowledgeBaseIndexedSharePointReference(String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>, String)
|
Initializes a new instance of KnowledgeBaseIndexedSharePointReference.
|
|
KnowledgeBaseMessage(String, IEnumerable<KnowledgeBaseMessageContent>)
|
The natural language message style object.
|
|
KnowledgeBaseMessageContent(String)
|
Specifies the type of the message content.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseMessageTextContent and KnowledgeBaseMessageImageContent.
|
|
KnowledgeBaseMessageImageContent(KnowledgeBaseImageContent)
|
Image message type.
|
|
KnowledgeBaseMessageTextContent(String)
|
Text message type.
|
|
KnowledgeBaseModel(String)
|
Specifies the connection parameters for the model to use for query planning.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseAzureOpenAIModel.
|
|
KnowledgeBaseModelAnswerSynthesisActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail, Nullable<Int32>, Nullable<Int32>)
|
Initializes a new instance of KnowledgeBaseModelAnswerSynthesisActivityRecord.
|
|
KnowledgeBaseModelQueryPlanningActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail, Nullable<Int32>, Nullable<Int32>)
|
Initializes a new instance of KnowledgeBaseModelQueryPlanningActivityRecord.
|
|
KnowledgeBaseModelWebSummarizationActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail, Nullable<Int32>, Nullable<Int32>)
|
Represents an LLM web summarization activity record.
|
|
KnowledgeBaseReference(String, String, Int32, IDictionary<String,BinaryData>, Nullable<Single>)
|
Base type for references.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeBaseSearchIndexReference, KnowledgeBaseAzureBlobReference, KnowledgeBaseIndexedOneLakeReference, and KnowledgeBaseWebReference.
|
|
KnowledgeBaseReference(String, String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>)
|
Initializes a new instance of KnowledgeBaseReference.
|
|
KnowledgeBaseRemoteSharePointActivityArguments(String, String)
|
Initializes a new instance of KnowledgeBaseRemoteSharePointActivityArguments.
|
|
KnowledgeBaseRemoteSharePointActivityRecord(Int32, Nullable<Int32>,
KnowledgeBaseErrorDetail, String, Nullable<DateTimeOffset>, Nullable<Int32>,
KnowledgeBaseRemoteSharePointActivityArguments)
|
Initializes a new instance of KnowledgeBaseRemoteSharePointActivityRecord.
|
|
KnowledgeBaseRemoteSharePointReference(String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>, Uri, SharePointSensitivityLabelInfo)
|
Initializes a new instance of KnowledgeBaseRemoteSharePointReference.
|
|
KnowledgeBaseRetrievalActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail, String, Nullable<DateTimeOffset>, Nullable<Int32>)
|
Initializes a new instance of KnowledgeBaseRetrievalActivityRecord.
|
|
KnowledgeBaseRetrievalRequest(IEnumerable<KnowledgeRetrievalIntent>,
Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, IEnumerable<KnowledgeSourceParams>)
|
The input contract for the retrieval request.
|
|
KnowledgeBaseRetrievalResponse(IEnumerable<KnowledgeBaseMessage>, IEnumerable<KnowledgeBaseActivityRecord>, IEnumerable<KnowledgeBaseReference>)
|
The output contract for the retrieval response.
|
|
KnowledgeBaseSearchIndexActivityArguments(String, String, IEnumerable<SearchIndexFieldReference>, IEnumerable<SearchIndexFieldReference>, String)
|
Initializes a new instance of KnowledgeBaseSearchIndexActivityArguments.
|
|
KnowledgeBaseSearchIndexActivityRecord(Int32, Nullable<Int32>,
KnowledgeBaseErrorDetail, String, Nullable<DateTimeOffset>, Nullable<Int32>,
KnowledgeBaseSearchIndexActivityArguments)
|
Initializes a new instance of KnowledgeBaseSearchIndexActivityRecord.
|
|
KnowledgeBaseSearchIndexReference(String, Int32, IDictionary<String,BinaryData>, Nullable<Single>, String)
|
Represents an Azure Search document reference.
|
|
KnowledgeBaseSearchIndexReference(String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>, String)
|
Initializes a new instance of KnowledgeBaseSearchIndexReference.
|
|
KnowledgeBaseWebActivityArguments(String, String, String, Nullable<Int32>, String)
|
Initializes a new instance of KnowledgeBaseWebActivityArguments.
|
|
KnowledgeBaseWebActivityRecord(Int32, Nullable<Int32>, KnowledgeBaseErrorDetail,
String, Nullable<DateTimeOffset>, Nullable<Int32>, KnowledgeBaseWebActivityArguments)
|
Initializes a new instance of KnowledgeBaseWebActivityRecord.
|
|
KnowledgeBaseWebReference(String, Int32, IDictionary<String,BinaryData>, Nullable<Single>, Uri, String)
|
Represents a web document reference.
|
|
KnowledgeBaseWebReference(String, Int32, IReadOnlyDictionary<String,Object>, Nullable<Single>, Uri, String)
|
Initializes a new instance of KnowledgeBaseWebReference.
|
|
KnowledgeRetrievalIntent(String)
|
An intended query to execute without model query planning.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeRetrievalSemanticIntent.
|
|
KnowledgeRetrievalMinimalReasoningEffort()
|
Run knowledge retrieval with minimal reasoning effort.
|
|
KnowledgeRetrievalReasoningEffort(String)
|
Base type for reasoning effort.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeRetrievalMinimalReasoningEffort.
|
|
KnowledgeRetrievalSemanticIntent(String)
|
A semantic query intent.
|
|
KnowledgeSource(String, String, String, Nullable<ETag>, SearchResourceEncryptionKey)
|
Represents a knowledge source definition.
Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSource, AzureBlobKnowledgeSource, IndexedOneLakeKnowledgeSource, and WebKnowledgeSource.
|
|
KnowledgeSourceAzureOpenAIVectorizer(AzureOpenAIVectorizerParameters)
|
Specifies the Azure OpenAI resource used to vectorize a query string.
|
|
KnowledgeSourceIngestionParameters(SearchIndexerDataIdentity,
KnowledgeSourceVectorizer, KnowledgeBaseModel, Nullable<Boolean>,
IndexingSchedule, Nullable<KnowledgeSourceContentExtractionMode>,
AIServices)
|
Consolidates all general ingestion settings for knowledge sources.
|
|
KnowledgeSourceParams(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, String)
|
Base type for knowledge source runtime parameters.
Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexKnowledgeSourceParams, AzureBlobKnowledgeSourceParams, IndexedOneLakeKnowledgeSourceParams, and WebKnowledgeSourceParams.
|
|
KnowledgeSourceReference(String)
|
Reference to a knowledge source.
|
|
KnowledgeSourceStatistics(Int32, String, Int32)
|
Statistical information about knowledge source synchronization history.
|
|
KnowledgeSourceStatus(KnowledgeSourceSynchronizationStatus, String, SynchronizationState, CompletedSynchronizationState, KnowledgeSourceStatistics)
|
Initializes a new instance of KnowledgeSourceStatus.
|
|
KnowledgeSourceStatus(Nullable<KnowledgeSourceKind>, KnowledgeSourceSynchronizationStatus,
String, SynchronizationState, CompletedSynchronizationState,
KnowledgeSourceStatistics)
|
Represents the status and synchronization history of a knowledge source.
|
|
KnowledgeSourceSynchronizationError(String, Nullable<Int32>, String, String, String, Uri)
|
Represents a document-level indexing error encountered during a knowledge source synchronization run.
|
|
KnowledgeSourceVectorizer(String)
|
Specifies the vectorization method to be used for knowledge source embedding model.
Please note this is the abstract base class. The derived classes available for instantiation are: KnowledgeSourceAzureOpenAIVectorizer.
|
|
KnowledgeStore(String, IEnumerable<KnowledgeStoreProjection>, SearchIndexerDataIdentity)
|
Definition of additional projections to azure blob, table, or files, of enriched data.
|
|
KnowledgeStoreFileProjectionSelector(String, String, String, String, IEnumerable<InputFieldMappingEntry>, String)
|
Projection definition for what data to store in Azure Files.
|
|
KnowledgeStoreObjectProjectionSelector(String, String, String, String, IEnumerable<InputFieldMappingEntry>, String)
|
Projection definition for what data to store in Azure Blob.
|
|
KnowledgeStoreProjection(IEnumerable<KnowledgeStoreTableProjectionSelector>,
IEnumerable<KnowledgeStoreObjectProjectionSelector>, IEnumerable<KnowledgeStoreFileProjectionSelector>)
|
Container object for various projection selectors.
|
|
KnowledgeStoreProjectionSelector(String, String, String, String, IEnumerable<InputFieldMappingEntry>)
|
Abstract class to share properties between concrete selectors.
|
|
KnowledgeStoreStorageProjectionSelector(String, String, String, String, IEnumerable<InputFieldMappingEntry>, String)
|
Abstract class to share properties between concrete selectors.
|
|
KnowledgeStoreTableProjectionSelector(String, String, String, String, IEnumerable<InputFieldMappingEntry>, String)
|
Description for what data to store in Azure Tables.
|
|
LanguageDetectionSkill(String, String, String, IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>, String, String)
|
A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis.
|
|
LengthTokenFilter(String, Nullable<Int32>, Nullable<Int32>)
|
Removes words that are too long or too short. This token filter is implemented using Apache Lucene.
|
|
LexicalAnalyzer(String, String)
|
Initializes a new instance of LexicalAnalyzer.
|
|
LexicalNormalizer(String, String)
|
Base type for normalizers.
|
|
LexicalTokenizer(String, String)
|
Initializes a new instance of LexicalTokenizer.
|
|
LimitTokenFilter(String, Nullable<Int32>, Nullable<Boolean>)
|
Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.
|
|
ListIndexStatsSummary(IEnumerable<IndexStatisticsSummary>)
|
Initializes a new instance of ListIndexStatsSummary.
|
|
LuceneStandardAnalyzer(String, Nullable<Int32>, IEnumerable<String>)
|
Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.
|
|
LuceneStandardTokenizer(String, Nullable<Int32>)
|
Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.
|
|
MagnitudeScoringFunction(String, Double, Nullable<ScoringFunctionInterpolation>, MagnitudeScoringParameters)
|
Defines a function that boosts scores based on the magnitude of a numeric field.
|
|
MagnitudeScoringParameters(Double, Double, Nullable<Boolean>)
|
Provides parameter values to a magnitude scoring function.
|
|
MappingCharFilter(String, IEnumerable<String>)
|
A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.
|
|
MergeSkill(String, String, String, IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>, String, String)
|
A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part.
|
|
MicrosoftLanguageStemmingTokenizer(String, Nullable<Int32>, Nullable<Boolean>, Nullable<MicrosoftStemmingTokenizerLanguage>)
|
Divides text using language-specific rules and reduces words to their base forms.
|
|
MicrosoftLanguageTokenizer(String, Nullable<Int32>, Nullable<Boolean>, Nullable<MicrosoftTokenizerLanguage>)
|
Divides text using language-specific rules.
|
|
NativeBlobSoftDeleteDeletionDetectionPolicy()
|
Defines a data deletion detection policy utilizing Azure Blob Storage's native soft delete feature for deletion detection.
|
|
NGramTokenFilter(String, Nullable<Int32>, Nullable<Int32>)
|
Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.
|
|
NGramTokenizer(String, Nullable<Int32>, Nullable<Int32>, IEnumerable<TokenCharacterKind>)
|
Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.
|
|
OcrSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<OcrSkillLanguage>,
Nullable<Boolean>, Nullable<OcrLineEnding>)
|
A skill that extracts text from image files.
|
|
OutputFieldMappingEntry(String, String)
|
Output field mapping for a skill.
|
|
PathHierarchyTokenizer(String, Nullable<Char>, Nullable<Char>, Nullable<Int32>, Nullable<Boolean>, Nullable<Int32>)
|
Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.
|
|
PatternAnalyzer(String, Nullable<Boolean>, String, String, IEnumerable<String>)
|
Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.
|
|
PatternCaptureTokenFilter(String, IEnumerable<String>, Nullable<Boolean>)
|
Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.
|
|
PatternReplaceCharFilter(String, String, String)
|
A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This character filter is implemented using Apache Lucene.
|
|
PatternReplaceTokenFilter(String, String, String)
|
A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This token filter is implemented using Apache Lucene.
|
|
PatternTokenizer(String, String, String, Nullable<Int32>)
|
Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.
|
|
PhoneticTokenFilter(String, Nullable<PhoneticEncoder>, Nullable<Boolean>)
|
Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.
|
|
PiiDetectionSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, String, Nullable<Double>,
Nullable<PiiDetectionSkillMaskingMode>, String, String, IEnumerable<String>,
String)
|
Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.
|
|
QueryAnswerResult(Nullable<Double>, String, String, String, IDictionary<String,Object>)
|
An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected.
|
|
QueryAnswerResult(Nullable<Double>, String, String, String, IReadOnlyDictionary<String,Object>)
|
Initializes a new instance of QueryAnswerResult.
|
|
QueryCaptionResult(String, String, IReadOnlyDictionary<String,Object>)
|
Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type semantic.
|
|
QueryResultDocumentInnerHit(Nullable<Int64>, IEnumerable<IDictionary<String,SingleVectorFieldResult>>)
|
Initializes a new instance of QueryResultDocumentInnerHit.
|
|
QueryResultDocumentRerankerInput(String, String, String)
|
Initializes a new instance of QueryResultDocumentRerankerInput.
|
|
QueryResultDocumentSemanticField(String, Nullable<SemanticFieldState>)
|
Initializes a new instance of QueryResultDocumentSemanticField.
|
|
QueryResultDocumentSubscores(TextResult, IEnumerable<IDictionary<String,SingleVectorFieldResult>>, Nullable<Double>)
|
The breakdown of subscores between the text and vector query components of the search query for this document. Each vector query is shown as a separate object in the same order they were received.
|
|
QueryRewritesDebugInfo(QueryRewritesValuesDebugInfo, IEnumerable<QueryRewritesValuesDebugInfo>)
|
Initializes a new instance of QueryRewritesDebugInfo.
|
|
QueryRewritesValuesDebugInfo(String, IEnumerable<String>)
|
Initializes a new instance of QueryRewritesValuesDebugInfo.
|
|
RescoringOptions(Nullable<Boolean>, Nullable<Double>, Nullable<VectorSearchCompressionRescoreStorageMethod>)
|
Contains the options for rescoring.
|
|
ScalarQuantizationCompression(String, RescoringOptions, Nullable<Int32>, ScalarQuantizationParameters)
|
Contains configuration options specific to the scalar quantization compression method used during indexing and querying.
|
|
ScalarQuantizationParameters(Nullable<VectorSearchCompressionTarget>)
|
Contains the parameters specific to Scalar Quantization.
|
|
ScoringFunction(String, Double, Nullable<ScoringFunctionInterpolation>, String)
|
Base type for functions that can modify document scores during ranking.
|
|
ScoringFunction(String, String, Double, Nullable<ScoringFunctionInterpolation>)
|
Initializes a new instance of ScoringFunction.
|
|
ScoringProfile(String, TextWeights, IEnumerable<ScoringFunction>, Nullable<ScoringFunctionAggregation>)
|
Defines parameters for a search index that influence scoring in search queries.
|
|
SearchAlias(String, IEnumerable<String>, String)
|
Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations.
|
|
SearchAlias(String, IList<String>, String, IDictionary<String,BinaryData>)
|
Initializes a new instance of SearchAlias(String, IList<String>, String, IDictionary<String,BinaryData>).
|
|
SearchField(String, SearchFieldDataType, Nullable<Boolean>, Nullable<Boolean>,
Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>,
Nullable<Boolean>, Nullable<LexicalAnalyzerName>, Nullable<LexicalAnalyzerName>,
Nullable<LexicalAnalyzerName>, Nullable<LexicalNormalizerName>,
Nullable<Int32>, String, Nullable<VectorEncodingFormat>, IEnumerable<String>,
IEnumerable<SearchField>)
|
Represents a field in an index definition, which describes the name, data type, and search behavior of a field.
|
|
SearchIndex(String, String, IEnumerable<ScoringProfile>, String,
CorsOptions, IEnumerable<SearchSuggester>, IEnumerable<LexicalAnalyzer>,
IEnumerable<LexicalTokenizer>, IEnumerable<TokenFilter>, IEnumerable<CharFilter>,
IEnumerable<LexicalNormalizer>, SearchResourceEncryptionKey,
SimilarityAlgorithm, SemanticSearch, VectorSearch, IEnumerable<SearchField>,
String)
|
Represents a search index definition, which describes the fields and search behavior of an index.
|
|
SearchIndex(String, String, IList<SearchField>, IList<ScoringProfile>,
String, CorsOptions, IList<SearchSuggester>, IList<LexicalAnalyzer>,
IList<LexicalTokenizer>, IList<TokenFilter>, IList<CharFilter>,
IList<LexicalNormalizer>, SearchResourceEncryptionKey, SimilarityAlgorithm,
SemanticSearch, VectorSearch, SearchIndexPermissionFilterOption,
String, IDictionary<String,BinaryData>)
|
Initializes a new instance of SearchIndex.
|
|
SearchIndexer(String, String, String, String, String, IndexingSchedule,
IndexingParameters, IEnumerable<FieldMapping>, IEnumerable<FieldMapping>,
Nullable<Boolean>, Nullable<ETag>, SearchResourceEncryptionKey)
|
Represents an indexer.
|
|
SearchIndexer(String, String, String, String, String, IndexingSchedule,
IndexingParameters, IList<FieldMapping>, IList<FieldMapping>,
Nullable<Boolean>, Nullable<ETag>, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>)
|
Initializes a new instance of SearchIndexer.
|
|
SearchIndexer(String, String, String, String, String, IndexingSchedule,
IndexingParameters, IList<FieldMapping>, IList<FieldMapping>,
Nullable<Boolean>, String, SearchResourceEncryptionKey, SearchIndexerCache,
IDictionary<String,BinaryData>)
|
Initializes a new instance of SearchIndexer.
|
|
SearchIndexerDataContainer(String, String)
|
Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed.
|
|
SearchIndexerDataIdentity(String)
|
Abstract base type for data identities.
Please note this is the abstract base class. The derived classes available for instantiation are: SearchIndexerDataNoneIdentity and SearchIndexerDataUserAssignedIdentity.
|
|
SearchIndexerDataNoneIdentity()
|
Clears the identity property of a datasource.
|
|
SearchIndexerDataSourceConnection(String, String, SearchIndexerDataSourceType,
String, SearchIndexerDataContainer, DataChangeDetectionPolicy,
DataDeletionDetectionPolicy, String, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>)
|
Initializes a new instance of SearchIndexerDataSourceConnection(String, String, SearchIndexerDataSourceType,
String, SearchIndexerDataContainer, DataChangeDetectionPolicy,
DataDeletionDetectionPolicy, String, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>).
|
|
SearchIndexerDataUserAssignedIdentity(String)
|
Specifies the identity for a datasource to use.
|
|
SearchIndexerError(String, String, Int32, String, String, String)
|
Initializes a new instance of SearchIndexerError.
|
|
SearchIndexerIndexProjection(IEnumerable<SearchIndexerIndexProjectionSelector>, SearchIndexerIndexProjectionsParameters)
|
Definition of additional projections to secondary search indexes.
|
|
SearchIndexerIndexProjectionSelector(String, String, String, IEnumerable<InputFieldMappingEntry>)
|
Description for what data to store in the designated search index.
|
|
SearchIndexerIndexProjectionsParameters(Nullable<IndexProjectionMode>, IDictionary<String,Object>)
|
A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
|
|
SearchIndexerLimits(Nullable<TimeSpan>, Nullable<Int64>, Nullable<Int64>)
|
Initializes a new instance of SearchIndexerLimits.
|
|
SearchIndexerSkill(String, String, String, String, IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>)
|
Base type for skills.
|
|
SearchIndexerSkill(String, String, String, String, IList<InputFieldMappingEntry>, IList<OutputFieldMappingEntry>)
|
Initializes a new instance of SearchIndexerSkill.
|
|
SearchIndexerSkillset(String, String, IEnumerable<SearchIndexerSkill>,
CognitiveServicesAccount, KnowledgeStore, SearchIndexerIndexProjection,
Nullable<ETag>, SearchResourceEncryptionKey)
|
A list of skills.
|
|
SearchIndexerStatus(String, IndexerStatus, IndexerRuntime, IndexerExecutionResult,
IEnumerable<IndexerExecutionResult>, SearchIndexerLimits, IndexerState)
|
Initializes a new instance of SearchIndexerStatus.
|
|
SearchIndexerWarning(String, String, String, String, String)
|
Initializes a new instance of SearchIndexerWarning.
|
|
SearchIndexFieldReference(String)
|
Field reference for a search index.
|
|
SearchIndexKnowledgeSource(String, String, Nullable<ETag>, SearchResourceEncryptionKey, SearchIndexKnowledgeSourceParameters)
|
Knowledge Source targeting a search index.
|
|
SearchIndexKnowledgeSource(String, String, String, String, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>, SearchIndexKnowledgeSourceParameters)
|
Initializes a new instance of SearchIndexKnowledgeSource(String, String, String, String, SearchResourceEncryptionKey,
IDictionary<String,BinaryData>, SearchIndexKnowledgeSourceParameters).
|
|
SearchIndexKnowledgeSourceParameters(String, IEnumerable<SearchIndexFieldReference>, IEnumerable<SearchIndexFieldReference>, String)
|
Parameters for search index knowledge source.
|
|
SearchIndexKnowledgeSourceParams(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, String)
|
Specifies runtime parameters for a search index knowledge source.
|
|
SearchIndexResponse(String, String, IEnumerable<SearchField>,
IEnumerable<ScoringProfile>, String, CorsOptions, IEnumerable<SearchSuggester>,
IEnumerable<LexicalAnalyzer>, IEnumerable<LexicalTokenizer>,
IEnumerable<TokenFilter>, IEnumerable<CharFilter>, IEnumerable<LexicalNormalizer>,
SearchResourceEncryptionKey, SimilarityAlgorithm, SemanticSearch,
VectorSearch, Nullable<ETag>)
|
Represents a search index definition, which describes the fields and search behavior of an index.
|
|
SearchIndexStatistics(Int64, Int64, Int64)
|
Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.
|
|
SearchOptions(Nullable<Boolean>, IEnumerable<String>, String,
String, String, String, Nullable<Double>, String, Nullable<SearchQueryType>,
Nullable<ScoringStatistics>, String, IEnumerable<String>, String,
Nullable<QueryDebugMode>, String, String, Nullable<SearchMode>,
String, Nullable<Int32>, Nullable<Int32>, String, Nullable<SemanticErrorMode>,
Nullable<Int32>, String, String, String, IEnumerable<VectorQuery>,
Nullable<VectorFilterMode>)
|
Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
|
|
SearchResourceCounter(Int64, Nullable<Int64>)
|
Initializes a new instance of SearchResourceCounter.
|
|
SearchResult<T>(T, Nullable<Double>, IDictionary<String,IList<String>>, SemanticSearchResult, DocumentDebugInfo)
|
Initializes a new instance of SearchResult.
|
|
SearchResults<T>(IEnumerable<SearchResult<T>>, Nullable<Int64>,
IDictionary<String,IList<FacetResult>>, Nullable<Double>, Response,
SemanticSearchResults, DebugInfo)
|
Initializes a new instance of SearchResults.
|
|
SearchResultsPage<T>(SearchResults<T>)
|
Initializes a new instance of SearchResultsPage.
|
|
SearchServiceCounters(SearchResourceCounter, SearchResourceCounter,
SearchResourceCounter, SearchResourceCounter, SearchResourceCounter,
SearchResourceCounter, SearchResourceCounter, SearchResourceCounter,
SearchResourceCounter)
|
Represents service-level resource counters and quotas.
|
|
SearchServiceLimits(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, Nullable<Int64>, Nullable<Int64>)
|
Represents various service level limits.
|
|
SearchServiceStatistics(SearchServiceCounters, SearchServiceLimits)
|
Initializes a new instance of SearchServiceStatistics.
|
|
SearchServiceStatistics(SearchServiceCounters, ServiceIndexersRuntime, SearchServiceLimits)
|
Initializes a new instance of SearchServiceStatistics.
|
|
SearchSuggester(String, IEnumerable<String>)
|
Defines how the Suggest API should apply to a group of fields in the index.
|
|
SearchSuggestion<T>(T, String)
|
Initializes a new instance of SearchSuggestion.
|
|
SemanticConfiguration(String, SemanticPrioritizedFields, Nullable<RankingOrder>)
|
Defines a specific configuration to be used in the context of semantic capabilities.
|
|
SemanticDebugInfo(QueryResultDocumentSemanticField, IEnumerable<QueryResultDocumentSemanticField>,
IEnumerable<QueryResultDocumentSemanticField>, QueryResultDocumentRerankerInput)
|
Initializes a new instance of SemanticDebugInfo.
|
|
SemanticField(String)
|
A field that is used as part of the semantic configuration.
|
|
SemanticPrioritizedFields(SemanticField, IEnumerable<SemanticField>, IEnumerable<SemanticField>)
|
Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.
|
|
SemanticSearch(String, IEnumerable<SemanticConfiguration>)
|
Defines parameters for a search index that influence semantic capabilities.
|
|
SemanticSearchResult(Nullable<Double>, Nullable<Double>, IReadOnlyList<QueryCaptionResult>)
|
Initializes a new instance of SemanticSearchResult.
|
|
SemanticSearchResults(IReadOnlyList<QueryAnswerResult>, Nullable<SemanticErrorReason>,
Nullable<SemanticSearchResultsType>, Nullable<SemanticQueryRewritesResultType>)
|
Initializes a new instance of SemanticSearchResults.
|
|
SentimentSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<SentimentSkillLanguage>,
Nullable<Boolean>, String)
|
Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as "negative", "neutral" and "positive") based on the highest confidence score found by the service at a sentence and document-level.
|
|
ServiceIndexersRuntime(Int64, Nullable<Int64>, DateTimeOffset, DateTimeOffset)
|
Initializes a new instance of ServiceIndexersRuntime.
|
|
ShaperSkill(String, String, String, IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>)
|
A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields).
|
|
SharePointSensitivityLabelInfo(String, String, String, Nullable<Int32>, String, Nullable<Boolean>)
|
Initializes a new instance of SharePointSensitivityLabelInfo.
|
|
ShingleTokenFilter(String, Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, Nullable<Boolean>, String, String)
|
Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.
|
|
SimilarityAlgorithm(String)
|
Initializes a new instance of SimilarityAlgorithm.
|
|
SingleVectorFieldResult(Nullable<Double>, Nullable<Double>)
|
A single vector field result. Both.
|
|
SnowballTokenFilter(String, SnowballTokenFilterLanguage)
|
A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.
|
|
SoftDeleteColumnDeletionDetectionPolicy(String, String)
|
Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.
|
|
SplitSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, Nullable<SplitSkillLanguage>,
Nullable<TextSplitMode>, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>)
|
A skill to split a string into chunks of text.
|
|
SqlIntegratedChangeTrackingPolicy()
|
Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.
|
|
StemmerOverrideTokenFilter(String, IEnumerable<String>)
|
Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html.
|
|
StemmerTokenFilter(String, StemmerTokenFilterLanguage)
|
Language specific stemming filter. This token filter is implemented using Apache Lucene. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters.
|
|
StopAnalyzer(String, IEnumerable<String>)
|
Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.
|
|
StopwordsTokenFilter(String, IEnumerable<String>, Nullable<StopwordsList>, Nullable<Boolean>, Nullable<Boolean>)
|
Removes stop words from a token stream. This token filter is implemented using Apache Lucene. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html.
|
|
SuggestOptions(String, Nullable<Boolean>, String, String, Nullable<Double>, String, String, String, String, String, Nullable<Int32>)
|
The SuggestOptions.
|
|
SuggestResults<T>(IReadOnlyList<SearchSuggestion<T>>, Nullable<Double>)
|
Initializes a new instance of SearchResult.
|
|
SynchronizationState(DateTimeOffset, Int32, Int32, Int32, IEnumerable<KnowledgeSourceSynchronizationError>)
|
Represents the current state of an ongoing synchronization that spans multiple indexer runs.
|
|
SynchronizationState(DateTimeOffset, Int32, Int32, Int32)
|
Initializes a new instance of SynchronizationState.
|
|
SynonymMap(String, IEnumerable<String>, SearchResourceEncryptionKey, String)
|
Represents a synonym map definition.
|
|
SynonymMap(String, String, String, SearchResourceEncryptionKey, String, IDictionary<String,BinaryData>)
|
Initializes a new instance of SynonymMap.
|
|
SynonymTokenFilter(String, IEnumerable<String>, Nullable<Boolean>, Nullable<Boolean>)
|
Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.
|
|
TagScoringFunction(String, Double, Nullable<ScoringFunctionInterpolation>, TagScoringParameters)
|
Defines a function that boosts scores of documents with string values matching a given list of tags.
|
|
TagScoringParameters(String)
|
Provides parameter values to a tag scoring function.
|
|
TextResult(Nullable<Double>)
|
The BM25 or Classic score for the text portion of the query.
|
|
TextTranslationSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, TextTranslationSkillLanguage,
Nullable<TextTranslationSkillLanguage>, Nullable<TextTranslationSkillLanguage>)
|
A skill to translate text from one language to another.
|
|
TextWeights(IDictionary<String,Double>)
|
Defines weights on index fields for which matches should boost scoring in search queries.
|
|
TokenFilter(String, String)
|
Initializes a new instance of TokenFilter.
|
|
TruncateTokenFilter(String, Nullable<Int32>)
|
Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.
|
|
UaxUrlEmailTokenizer(String, Nullable<Int32>)
|
Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.
|
|
UniqueTokenFilter(String, Nullable<Boolean>)
|
Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.
|
|
VectorizableImageBinaryQuery(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Double>, Nullable<Single>, String)
|
The query parameters to use for vector search when a base 64 encoded binary of an image that needs to be vectorized is provided.
|
|
VectorizableImageUrlQuery(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Double>, Nullable<Single>, Uri)
|
The query parameters to use for vector search when an url that represents an image value that needs to be vectorized is provided.
|
|
VectorizableTextQuery(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Double>, Nullable<Single>, String)
|
The query parameters to use for vector search when a text value that needs to be vectorized is provided.
|
|
VectorizedQuery(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Double>, Nullable<Single>, ReadOnlyMemory<Single>)
|
The query parameters to use for vector search when a raw vector value is provided.
|
|
VectorQuery(Nullable<Int32>, String, Nullable<Boolean>, Nullable<Double>, Nullable<Single>, String)
|
The query parameters for vector and hybrid search queries.
Please note this is the abstract base class. The derived classes available for instantiation are: VectorizedQuery, VectorizableTextQuery, VectorizableImageUrlQuery, and VectorizableImageBinaryQuery.
|
|
VectorsDebugInfo(QueryResultDocumentSubscores)
|
"Contains debugging information specific to vector and hybrid search.").
|
|
VectorSearch(IEnumerable<VectorSearchProfile>, IEnumerable<VectorSearchAlgorithmConfiguration>,
IEnumerable<VectorSearchVectorizer>, IEnumerable<VectorSearchCompression>)
|
Contains configuration options related to vector search.
|
|
VectorSearchAlgorithmConfiguration(String, String)
|
Contains configuration options specific to the algorithm used during indexing or querying.
Please note this is the abstract base class. The derived classes available for instantiation are: HnswAlgorithmConfiguration and ExhaustiveKnnAlgorithmConfiguration.
|
|
VectorSearchCompression(String, RescoringOptions, Nullable<Int32>, String)
|
Contains configuration options specific to the compression method used during indexing or querying.
Please note this is the abstract base class. The derived classes available for instantiation are: ScalarQuantizationCompression and BinaryQuantizationCompression.
|
|
VectorSearchProfile(String, String, String, String)
|
Defines a combination of configurations to use with vector search.
|
|
VectorSearchVectorizer(String, String)
|
Specifies the vectorization method to be used during query time.
Please note this is the abstract base class. The derived classes available for instantiation are: AzureOpenAIVectorizer, WebApiVectorizer, and AzureMachineLearningVectorizer.
|
|
WebApiSkill(String, String, String, IEnumerable<InputFieldMappingEntry>,
IEnumerable<OutputFieldMappingEntry>, String, IDictionary<String,
String>, String, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>,
ResourceIdentifier, SearchIndexerDataIdentity)
|
A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.
|
|
WebApiVectorizer(String, WebApiVectorizerParameters)
|
Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset.
|
|
WebApiVectorizerParameters(Uri, IDictionary<String,String>, String, Nullable<TimeSpan>, ResourceIdentifier, SearchIndexerDataIdentity)
|
Specifies the properties for connecting to a user-defined vectorizer.
|
|
WebKnowledgeSource(String, String, Nullable<ETag>, SearchResourceEncryptionKey, WebKnowledgeSourceParameters)
|
Knowledge Source targeting web results.
|
|
WebKnowledgeSourceDomain(String, Nullable<Boolean>)
|
Configuration for web knowledge source domain.
|
|
WebKnowledgeSourceDomains(IEnumerable<WebKnowledgeSourceDomain>, IEnumerable<WebKnowledgeSourceDomain>)
|
Domain allow/block configuration for web knowledge source.
|
|
WebKnowledgeSourceParameters(WebKnowledgeSourceDomains)
|
Parameters for web knowledge source.
|
|
WebKnowledgeSourceParams(String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Single>, String, String, Nullable<Int32>, String)
|
Specifies runtime parameters for a web knowledge source.
|
|
WordDelimiterTokenFilter(String, Nullable<Boolean>, Nullable<Boolean>,
Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>,
Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, IEnumerable<String>)
|
Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.
|
