From 43c8a03869409e6c37ebc45d32dc81f1c76eadbf Mon Sep 17 00:00:00 2001 From: SDKAuto Date: Mon, 23 Oct 2023 22:04:25 +0000 Subject: [PATCH] CodeGen from PR 26327 in Azure/azure-rest-api-specs Merge 0eef6270c9d82fab428bed560a6079704e893644 into 7c906b15744aaf7b782dfb82ccefcbef05cbf20b --- .../Models/AsciiFoldingTokenFilter.cs | 2 +- .../Models/AzureMachineLearningSkill.cs | 2 +- .../Models/AzureOpenAIEmbeddingSkill.cs | 16 +- .../Generated/Models/AzureOpenAIParameters.cs | 14 +- .../Generated/Models/AzureOpenAIVectorizer.cs | 6 +- .../Models/BlobIndexerParsingMode.cs | 4 +- .../src/Generated/Models/CharFilter.cs | 4 +- .../src/Generated/Models/CharFilterName.cs | 2 +- .../Generated/Models/CjkBigramTokenFilter.cs | 2 +- .../src/Generated/Models/ClassicTokenizer.cs | 2 +- .../Models/CognitiveServicesAccount.cs | 10 +- .../Models/CognitiveServicesAccountKey.cs | 12 +- .../Generated/Models/CommonGramTokenFilter.cs | 2 +- .../src/Generated/Models/ConditionalSkill.cs | 2 +- .../src/Generated/Models/CustomAnalyzer.cs | 2 +- .../Models/CustomEntityLookupSkill.cs | 6 +- .../src/Generated/Models/CustomNormalizer.cs | 2 +- .../src/Generated/Models/CustomVectorizer.cs | 6 +- .../Models/CustomVectorizerParameters.cs | 14 +- .../Models/DataChangeDetectionPolicy.cs | 4 +- .../Models/DataDeletionDetectionPolicy.cs | 4 +- .../Generated/Models/DataSourceCredentials.cs | 4 +- .../Models/DefaultCognitiveServicesAccount.cs | 6 +- .../DictionaryDecompounderTokenFilter.cs | 2 +- .../src/Generated/Models/DocumentDebugInfo.cs | 4 +- .../Models/DocumentExtractionSkill.cs | 2 +- .../Generated/Models/EdgeNGramTokenizer.cs | 2 +- .../Generated/Models/ElisionTokenFilter.cs | 2 +- .../Generated/Models/EntityLinkingSkill.cs | 6 +- .../Models/EntityRecognitionSkill.cs | 6 +- .../Models/EntityRecognitionSkillV3.cs | 10 +- .../HighWaterMarkChangeDetectionPolicy.cs | 2 +- .../src/Generated/Models/HnswParameters.cs | 2 +- .../HnswVectorSearchAlgorithmConfiguration.cs | 6 +- .../Generated/Models/ImageAnalysisSkill.cs | 6 +- .../Models/IndexerExecutionEnvironment.cs | 2 +- .../src/Generated/Models/KeepTokenFilter.cs | 2 +- .../Models/KeyPhraseExtractionSkill.cs | 6 +- .../Models/KeywordMarkerTokenFilter.cs | 2 +- .../Models/LanguageDetectionSkill.cs | 2 +- .../src/Generated/Models/LengthTokenFilter.cs | 2 +- .../src/Generated/Models/LexicalAnalyzer.cs | 4 +- .../Generated/Models/LexicalAnalyzerName.cs | 2 +- .../src/Generated/Models/LexicalNormalizer.cs | 4 +- .../Generated/Models/LexicalNormalizerName.cs | 2 +- .../src/Generated/Models/LexicalTokenizer.cs | 4 +- .../Generated/Models/LexicalTokenizerName.cs | 2 +- .../src/Generated/Models/LimitTokenFilter.cs | 2 +- .../Models/LuceneStandardAnalyzer.cs | 2 +- .../src/Generated/Models/MappingCharFilter.cs | 2 +- .../src/Generated/Models/MergeSkill.cs | 2 +- .../MicrosoftLanguageStemmingTokenizer.cs | 2 +- .../Models/MicrosoftLanguageTokenizer.cs | 2 +- .../src/Generated/Models/NGramTokenizer.cs | 2 +- ...veBlobSoftDeleteDeletionDetectionPolicy.cs | 2 +- .../src/Generated/Models/OcrSkill.cs | 4 +- .../Models/PathHierarchyTokenizer.cs | 2 +- .../src/Generated/Models/PatternAnalyzer.cs | 2 +- .../Models/PatternCaptureTokenFilter.cs | 2 +- .../Models/PatternReplaceCharFilter.cs | 2 +- .../Models/PatternReplaceTokenFilter.cs | 2 +- .../src/Generated/Models/PatternTokenizer.cs | 2 +- .../Generated/Models/PhoneticTokenFilter.cs | 2 +- .../src/Generated/Models/PiiDetectionSkill.cs | 4 +- .../src/Generated/Models/QueryAnswerType.cs | 2 +- .../src/Generated/Models/QueryCaptionType.cs | 2 +- .../src/Generated/Models/QueryDebugMode.cs | 2 +- .../src/Generated/Models/QueryLanguage.cs | 6 +- .../Generated/Models/SearchDocumentsResult.cs | 20 +-- .../src/Generated/Models/SearchError.cs | 2 +- .../src/Generated/Models/SearchField.cs | 4 +- .../src/Generated/Models/SearchIndex.cs | 4 +- .../src/Generated/Models/SearchIndexer.cs | 4 +- .../Models/SearchIndexerDataIdentity.cs | 4 +- .../Models/SearchIndexerDataNoneIdentity.cs | 2 +- .../SearchIndexerDataSourceConnection.cs | 4 +- .../SearchIndexerDataUserAssignedIdentity.cs | 2 +- .../Generated/Models/SearchIndexerSkill.cs | 4 +- .../Generated/Models/SearchIndexerSkillset.cs | 12 +- .../src/Generated/Models/SearchOptions.cs | 6 +- .../Models/SearchResourceEncryptionKey.cs | 4 +- .../Generated/Models/SearchServiceError.cs | 2 +- .../Models/SemanticPartialResponseReason.cs | 2 +- .../Models/SemanticPartialResponseType.cs | 2 +- .../src/Generated/Models/SentimentSkill.cs | 4 +- .../src/Generated/Models/SentimentSkillV3.cs | 6 +- .../src/Generated/Models/ShaperSkill.cs | 2 +- .../Generated/Models/ShingleTokenFilter.cs | 2 +- .../Generated/Models/SnowballTokenFilter.cs | 2 +- ...SoftDeleteColumnDeletionDetectionPolicy.cs | 2 +- .../src/Generated/Models/SplitSkill.cs | 6 +- .../SqlIntegratedChangeTrackingPolicy.cs | 2 +- .../Models/StemmerOverrideTokenFilter.cs | 2 +- .../Generated/Models/StemmerTokenFilter.cs | 2 +- .../src/Generated/Models/StopAnalyzer.cs | 2 +- .../Generated/Models/StopwordsTokenFilter.cs | 2 +- .../src/Generated/Models/SynonymMap.cs | 4 +- .../Generated/Models/SynonymTokenFilter.cs | 2 +- .../Generated/Models/TextTranslationSkill.cs | 6 +- .../src/Generated/Models/TokenFilter.cs | 4 +- .../src/Generated/Models/TokenFilterName.cs | 2 +- .../Generated/Models/TruncateTokenFilter.cs | 2 +- .../Generated/Models/UaxUrlEmailTokenizer.cs | 2 +- .../src/Generated/Models/UniqueTokenFilter.cs | 2 +- .../src/Generated/Models/UnknownCharFilter.cs | 2 +- .../Models/UnknownCognitiveServicesAccount.cs | 4 +- .../UnknownDataChangeDetectionPolicy.cs | 2 +- .../UnknownDataDeletionDetectionPolicy.cs | 2 +- .../Models/UnknownLexicalAnalyzer.cs | 2 +- .../Models/UnknownLexicalNormalizer.cs | 2 +- .../Models/UnknownLexicalTokenizer.cs | 2 +- .../UnknownSearchIndexerDataIdentity.cs | 2 +- .../Models/UnknownSearchIndexerSkill.cs | 2 +- .../Generated/Models/UnknownTokenFilter.cs | 2 +- .../src/Generated/Models/VectorSearch.cs | 4 +- .../VectorSearchAlgorithmConfiguration.cs | 2 +- .../Models/VectorSearchAlgorithmKind.cs | 2 +- .../Models/VectorSearchVectorizer.cs | 2 +- .../Models/VectorSearchVectorizerKind.cs | 2 +- .../src/Generated/Models/WebApiSkill.cs | 2 +- .../Models/WordDelimiterTokenFilter.cs | 2 +- .../src/Generated/SearchModelFactory.cs | 156 +++++++++--------- .../Azure.Search.Documents/src/autorest.md | 6 +- 123 files changed, 299 insertions(+), 299 deletions(-) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/AsciiFoldingTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/AsciiFoldingTokenFilter.cs index 67d8e6175bcb..a27496f29b36 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/AsciiFoldingTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/AsciiFoldingTokenFilter.cs @@ -24,7 +24,7 @@ public AsciiFoldingTokenFilter(string name) : base(name) } /// Initializes a new instance of AsciiFoldingTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A value indicating whether the original token will be kept. Default is false. internal AsciiFoldingTokenFilter(string oDataType, string name, bool? preserveOriginal) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureMachineLearningSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureMachineLearningSkill.cs index 5da1859bbd39..2a3fa9198f11 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureMachineLearningSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureMachineLearningSkill.cs @@ -15,7 +15,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class AzureMachineLearningSkill : SearchIndexerSkill { /// Initializes a new instance of AzureMachineLearningSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIEmbeddingSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIEmbeddingSkill.cs index f2048307c3bc..5e75b160c4da 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIEmbeddingSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIEmbeddingSkill.cs @@ -11,7 +11,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Allows you to generate a vector embedding for a given text input using the Azure Open AI service. + /// Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource. public partial class AzureOpenAIEmbeddingSkill : SearchIndexerSkill { /// Initializes a new instance of AzureOpenAIEmbeddingSkill. @@ -27,15 +27,15 @@ public AzureOpenAIEmbeddingSkill(IEnumerable inputs, IEn } /// Initializes a new instance of AzureOpenAIEmbeddingSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// The resource uri for your Azure Open AI resource. - /// ID of your Azure Open AI model deployment on the designated resource. - /// API key for the designated Azure Open AI resource. + /// The resource URI for your Azure OpenAI resource. + /// ID of your Azure OpenAI model deployment on the designated resource. + /// API key for the designated Azure OpenAI resource. /// /// The user-assigned managed identity used for outbound connections. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. @@ -50,11 +50,11 @@ internal AzureOpenAIEmbeddingSkill(string oDataType, string name, string descrip ODataType = oDataType ?? "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill"; } - /// The resource uri for your Azure Open AI resource. + /// The resource URI for your Azure OpenAI resource. public Uri ResourceUri { get; set; } - /// ID of your Azure Open AI model deployment on the designated resource. + /// ID of your Azure OpenAI model deployment on the designated resource. public string DeploymentId { get; set; } - /// API key for the designated Azure Open AI resource. + /// API key for the designated Azure OpenAI resource. public string ApiKey { get; set; } /// /// The user-assigned managed identity used for outbound connections. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIParameters.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIParameters.cs index 7ff21b588a6c..d10470e30a61 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIParameters.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIParameters.cs @@ -9,7 +9,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Contains the parameters specific to using an Azure Open AI service for vectorization at query time. + /// Specifies the parameters for connecting to the Azure OpenAI resource. public partial class AzureOpenAIParameters { /// Initializes a new instance of AzureOpenAIParameters. @@ -18,9 +18,9 @@ public AzureOpenAIParameters() } /// Initializes a new instance of AzureOpenAIParameters. - /// The resource uri for your Azure Open AI resource. - /// ID of your Azure Open AI model deployment on the designated resource. - /// API key for the designated Azure Open AI resource. + /// The resource URI of the Azure OpenAI resource. + /// ID of the Azure OpenAI model deployment on the designated resource. + /// API key of the designated Azure OpenAI resource. /// /// The user-assigned managed identity used for outbound connections. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. @@ -34,11 +34,11 @@ internal AzureOpenAIParameters(Uri resourceUri, string deploymentId, string apiK AuthIdentity = authIdentity; } - /// The resource uri for your Azure Open AI resource. + /// The resource URI of the Azure OpenAI resource. public Uri ResourceUri { get; set; } - /// ID of your Azure Open AI model deployment on the designated resource. + /// ID of the Azure OpenAI model deployment on the designated resource. public string DeploymentId { get; set; } - /// API key for the designated Azure Open AI resource. + /// API key of the designated Azure OpenAI resource. public string ApiKey { get; set; } /// /// The user-assigned managed identity used for outbound connections. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIVectorizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIVectorizer.cs index e88117361ebc..a48a8584adc7 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIVectorizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/AzureOpenAIVectorizer.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Contains the parameters specific to using an Azure Open AI service for vectorization at query time. + /// Specifies the Azure OpenAI resource used to vectorize a query string. public partial class AzureOpenAIVectorizer : VectorSearchVectorizer { /// Initializes a new instance of AzureOpenAIVectorizer. @@ -26,14 +26,14 @@ public AzureOpenAIVectorizer(string name) : base(name) /// Initializes a new instance of AzureOpenAIVectorizer. /// The name to associate with this particular vectorization method. /// The name of the kind of vectorization method being configured for use with vector search. - /// Contains the parameters specific to Azure Open AI embedding vectorization. + /// Contains the parameters specific to Azure OpenAI embedding vectorization. internal AzureOpenAIVectorizer(string name, VectorSearchVectorizerKind kind, AzureOpenAIParameters azureOpenAIParameters) : base(name, kind) { AzureOpenAIParameters = azureOpenAIParameters; Kind = kind; } - /// Contains the parameters specific to Azure Open AI embedding vectorization. + /// Contains the parameters specific to Azure OpenAI embedding vectorization. public AzureOpenAIParameters AzureOpenAIParameters { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/BlobIndexerParsingMode.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/BlobIndexerParsingMode.cs index a4d9563c968d..706a4875da12 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/BlobIndexerParsingMode.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/BlobIndexerParsingMode.cs @@ -37,9 +37,9 @@ public BlobIndexerParsingMode(string value) public static BlobIndexerParsingMode DelimitedText { get; } = new BlobIndexerParsingMode(DelimitedTextValue); /// Set to json to extract structured content from JSON files. public static BlobIndexerParsingMode Json { get; } = new BlobIndexerParsingMode(JsonValue); - /// Set to jsonArray to extract individual elements of a JSON array as separate documents in Azure Cognitive Search. + /// Set to jsonArray to extract individual elements of a JSON array as separate documents. public static BlobIndexerParsingMode JsonArray { get; } = new BlobIndexerParsingMode(JsonArrayValue); - /// Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents in Azure Cognitive Search. + /// Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. public static BlobIndexerParsingMode JsonLines { get; } = new BlobIndexerParsingMode(JsonLinesValue); /// Determines if two values are the same. public static bool operator ==(BlobIndexerParsingMode left, BlobIndexerParsingMode right) => left.Equals(right); diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilter.cs index cbadd371d46e..aa600de1ef34 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilter.cs @@ -18,7 +18,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class CharFilter { /// Initializes a new instance of CharFilter. - /// Identifies the concrete type of the char filter. + /// A URI fragment specifying the type of char filter. /// The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal CharFilter(string oDataType, string name) { @@ -26,7 +26,7 @@ internal CharFilter(string oDataType, string name) Name = name; } - /// Identifies the concrete type of the char filter. + /// A URI fragment specifying the type of char filter. internal string ODataType { get; set; } /// The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. public string Name { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilterName.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilterName.cs index d3068e3534bb..502ed1255c54 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilterName.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CharFilterName.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Defines the names of all character filters supported by Azure Cognitive Search. + /// Defines the names of all character filters supported by the search engine. public readonly partial struct CharFilterName : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CjkBigramTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CjkBigramTokenFilter.cs index 49da8a5ad82a..fed1742df800 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CjkBigramTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CjkBigramTokenFilter.cs @@ -26,7 +26,7 @@ public CjkBigramTokenFilter(string name) : base(name) } /// Initializes a new instance of CjkBigramTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The scripts to ignore. /// A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/ClassicTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/ClassicTokenizer.cs index 5f069df53d97..cdebdb63b604 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/ClassicTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/ClassicTokenizer.cs @@ -24,7 +24,7 @@ public ClassicTokenizer(string name) : base(name) } /// Initializes a new instance of ClassicTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. internal ClassicTokenizer(string oDataType, string name, int? maxTokenLength) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccount.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccount.cs index 0dc665b66048..cb8551f96c33 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccount.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccount.cs @@ -8,24 +8,24 @@ namespace Azure.Search.Documents.Indexes.Models { /// - /// Base type for describing any cognitive service resource attached to a skillset. + /// Base type for describing any Azure AI service resource attached to a skillset. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// public partial class CognitiveServicesAccount { /// Initializes a new instance of CognitiveServicesAccount. - /// Identifies the concrete type of the cognitive service resource attached to a skillset. - /// Description of the cognitive service resource attached to a skillset. + /// A URI fragment specifying the type of Azure AI service resource attached to a skillset. + /// Description of the Azure AI service resource attached to a skillset. internal CognitiveServicesAccount(string oDataType, string description) { ODataType = oDataType; Description = description; } - /// Identifies the concrete type of the cognitive service resource attached to a skillset. + /// A URI fragment specifying the type of Azure AI service resource attached to a skillset. internal string ODataType { get; set; } - /// Description of the cognitive service resource attached to a skillset. + /// Description of the Azure AI service resource attached to a skillset. public string Description { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccountKey.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccountKey.cs index f6d646fc0794..67465f87df64 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccountKey.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CognitiveServicesAccountKey.cs @@ -10,11 +10,11 @@ namespace Azure.Search.Documents.Indexes.Models { - /// A cognitive service resource provisioned with a key that is attached to a skillset. + /// The multi-region account key of an Azure AI service resource that's attached to a skillset. public partial class CognitiveServicesAccountKey : CognitiveServicesAccount { /// Initializes a new instance of CognitiveServicesAccountKey. - /// The key used to provision the cognitive service resource attached to a skillset. + /// The key used to provision the Azure AI service resource attached to a skillset. /// is null. public CognitiveServicesAccountKey(string key) { @@ -25,16 +25,16 @@ public CognitiveServicesAccountKey(string key) } /// Initializes a new instance of CognitiveServicesAccountKey. - /// Identifies the concrete type of the cognitive service resource attached to a skillset. - /// Description of the cognitive service resource attached to a skillset. - /// The key used to provision the cognitive service resource attached to a skillset. + /// A URI fragment specifying the type of Azure AI service resource attached to a skillset. + /// Description of the Azure AI service resource attached to a skillset. + /// The key used to provision the Azure AI service resource attached to a skillset. internal CognitiveServicesAccountKey(string oDataType, string description, string key) : base(oDataType, description) { Key = key; ODataType = oDataType ?? "#Microsoft.Azure.Search.CognitiveServicesByKey"; } - /// The key used to provision the cognitive service resource attached to a skillset. + /// The key used to provision the Azure AI service resource attached to a skillset. public string Key { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CommonGramTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CommonGramTokenFilter.cs index 82958f6e3e58..17b5c0ec1362 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CommonGramTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CommonGramTokenFilter.cs @@ -29,7 +29,7 @@ public CommonGramTokenFilter(string name, IEnumerable commonWords) : bas } /// Initializes a new instance of CommonGramTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The set of common words. /// A value indicating whether common words matching will be case insensitive. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/ConditionalSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/ConditionalSkill.cs index 7ef70be4199a..cde526a5e187 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/ConditionalSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/ConditionalSkill.cs @@ -27,7 +27,7 @@ public ConditionalSkill(IEnumerable inputs, IEnumerable< } /// Initializes a new instance of ConditionalSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomAnalyzer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomAnalyzer.cs index 9b9c84dbea41..774b51663a36 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomAnalyzer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomAnalyzer.cs @@ -15,7 +15,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class CustomAnalyzer : LexicalAnalyzer { /// Initializes a new instance of CustomAnalyzer. - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words. /// A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomEntityLookupSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomEntityLookupSkill.cs index 223634461d4f..90fd9195a8cf 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomEntityLookupSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomEntityLookupSkill.cs @@ -28,13 +28,13 @@ public CustomEntityLookupSkill(IEnumerable inputs, IEnum } /// Initializes a new instance of CustomEntityLookupSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS. /// The inline CustomEntity definition. /// A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. @@ -51,7 +51,7 @@ internal CustomEntityLookupSkill(string oDataType, string name, string descripti ODataType = oDataType ?? "#Microsoft.Skills.Text.CustomEntityLookupSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public CustomEntityLookupSkillLanguage? DefaultLanguageCode { get; set; } /// A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value. public bool? GlobalDefaultCaseSensitive { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomNormalizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomNormalizer.cs index 061bf1025f58..c31f41cf3ca7 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomNormalizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomNormalizer.cs @@ -27,7 +27,7 @@ public CustomNormalizer(string name) : base(name) } /// Initializes a new instance of CustomNormalizer. - /// Identifies the concrete type of the normalizer. + /// A URI fragment specifying the type of normalizer. /// The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. /// A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed. /// A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizer.cs index 4ab08910b84e..71b070467df6 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizer.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Contains the parameters specific to generating vector embeddings via a custom endpoint. + /// 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. public partial class CustomVectorizer : VectorSearchVectorizer { /// Initializes a new instance of CustomVectorizer. @@ -26,14 +26,14 @@ public CustomVectorizer(string name) : base(name) /// Initializes a new instance of CustomVectorizer. /// The name to associate with this particular vectorization method. /// The name of the kind of vectorization method being configured for use with vector search. - /// Contains the parameters specific to generating vector embeddings via a custom endpoint. + /// Specifies the properties of the user-defined vectorizer. internal CustomVectorizer(string name, VectorSearchVectorizerKind kind, CustomVectorizerParameters customVectorizerParameters) : base(name, kind) { CustomVectorizerParameters = customVectorizerParameters; Kind = kind; } - /// Contains the parameters specific to generating vector embeddings via a custom endpoint. + /// Specifies the properties of the user-defined vectorizer. public CustomVectorizerParameters CustomVectorizerParameters { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizerParameters.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizerParameters.cs index 9629ecae08ed..a5f0e24d163c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizerParameters.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/CustomVectorizerParameters.cs @@ -11,7 +11,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Contains the parameters specific to generating vector embeddings via a custom endpoint. + /// Specifies the properties for connecting to a user-defined vectorizer. public partial class CustomVectorizerParameters { /// Initializes a new instance of CustomVectorizerParameters. @@ -21,9 +21,9 @@ public CustomVectorizerParameters() } /// Initializes a new instance of CustomVectorizerParameters. - /// The uri for the Web API. - /// The headers required to make the http request. - /// The method for the http request. + /// The URI of the Web API providing the vectorizer. + /// The headers required to make the HTTP request. + /// The method for the HTTP request. /// The desired timeout for the request. Default is 30 seconds. /// Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token. /// @@ -41,11 +41,11 @@ internal CustomVectorizerParameters(Uri uri, IDictionary httpHea AuthIdentity = authIdentity; } - /// The uri for the Web API. + /// The URI of the Web API providing the vectorizer. public Uri Uri { get; set; } - /// The headers required to make the http request. + /// The headers required to make the HTTP request. public IDictionary HttpHeaders { get; } - /// The method for the http request. + /// The method for the HTTP request. public string HttpMethod { get; set; } /// The desired timeout for the request. Default is 30 seconds. public TimeSpan? Timeout { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DataChangeDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DataChangeDetectionPolicy.cs index fa0d2a348eff..1e8d5d281f25 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DataChangeDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DataChangeDetectionPolicy.cs @@ -15,13 +15,13 @@ namespace Azure.Search.Documents.Indexes.Models public partial class DataChangeDetectionPolicy { /// Initializes a new instance of DataChangeDetectionPolicy. - /// Identifies the concrete type of the data change detection policy. + /// A URI fragment specifying the type of data change detection policy. internal DataChangeDetectionPolicy(string oDataType) { ODataType = oDataType; } - /// Identifies the concrete type of the data change detection policy. + /// A URI fragment specifying the type of data change detection policy. internal string ODataType { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DataDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DataDeletionDetectionPolicy.cs index 86d3b9713270..277e872f0cc5 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DataDeletionDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DataDeletionDetectionPolicy.cs @@ -15,13 +15,13 @@ namespace Azure.Search.Documents.Indexes.Models public partial class DataDeletionDetectionPolicy { /// Initializes a new instance of DataDeletionDetectionPolicy. - /// Identifies the concrete type of the data deletion detection policy. + /// A URI fragment specifying the type of data deletion detection policy. internal DataDeletionDetectionPolicy(string oDataType) { ODataType = oDataType; } - /// Identifies the concrete type of the data deletion detection policy. + /// A URI fragment specifying the type of data deletion detection policy. internal string ODataType { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DataSourceCredentials.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DataSourceCredentials.cs index 8ea8fa82b48b..bb928d2b8b4f 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DataSourceCredentials.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DataSourceCredentials.cs @@ -16,13 +16,13 @@ public DataSourceCredentials() } /// Initializes a new instance of DataSourceCredentials. - /// The connection string for the datasource. Set to '<unchanged>' if you do not want the connection string updated. + /// The connection string for the datasource. Set to `<unchanged>` (with brackets) if you don't want the connection string updated. Set to `<redacted>` if you want to remove the connection string value from the datasource. internal DataSourceCredentials(string connectionString) { ConnectionString = connectionString; } - /// The connection string for the datasource. Set to '<unchanged>' if you do not want the connection string updated. + /// The connection string for the datasource. Set to `<unchanged>` (with brackets) if you don't want the connection string updated. Set to `<redacted>` if you want to remove the connection string value from the datasource. public string ConnectionString { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DefaultCognitiveServicesAccount.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DefaultCognitiveServicesAccount.cs index f2b5aa0ae1f0..6cc337b0e644 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DefaultCognitiveServicesAccount.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DefaultCognitiveServicesAccount.cs @@ -7,7 +7,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// An empty object that represents the default cognitive service resource for a skillset. + /// An empty object that represents the default Azure AI service resource for a skillset. public partial class DefaultCognitiveServicesAccount : CognitiveServicesAccount { /// Initializes a new instance of DefaultCognitiveServicesAccount. @@ -17,8 +17,8 @@ public DefaultCognitiveServicesAccount() } /// Initializes a new instance of DefaultCognitiveServicesAccount. - /// Identifies the concrete type of the cognitive service resource attached to a skillset. - /// Description of the cognitive service resource attached to a skillset. + /// A URI fragment specifying the type of Azure AI service resource attached to a skillset. + /// Description of the Azure AI service resource attached to a skillset. internal DefaultCognitiveServicesAccount(string oDataType, string description) : base(oDataType, description) { ODataType = oDataType ?? "#Microsoft.Azure.Search.DefaultCognitiveServices"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DictionaryDecompounderTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DictionaryDecompounderTokenFilter.cs index 9ba5c1c0b0f1..17f263d7d9d5 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DictionaryDecompounderTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DictionaryDecompounderTokenFilter.cs @@ -29,7 +29,7 @@ public DictionaryDecompounderTokenFilter(string name, IEnumerable wordLi } /// Initializes a new instance of DictionaryDecompounderTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The list of words to match against. /// The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentDebugInfo.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentDebugInfo.cs index eb0546b6f87b..166d06c0c448 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentDebugInfo.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentDebugInfo.cs @@ -16,13 +16,13 @@ internal DocumentDebugInfo() } /// Initializes a new instance of DocumentDebugInfo. - /// Contains debugging information specific to semantic search queries. + /// Contains debugging information specific to semantic ranking requests. internal DocumentDebugInfo(SemanticDebugInfo semantic) { Semantic = semantic; } - /// Contains debugging information specific to semantic search queries. + /// Contains debugging information specific to semantic ranking requests. public SemanticDebugInfo Semantic { get; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentExtractionSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentExtractionSkill.cs index ad5b481c5f96..c4b37136a65c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentExtractionSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/DocumentExtractionSkill.cs @@ -28,7 +28,7 @@ public DocumentExtractionSkill(IEnumerable inputs, IEnum } /// Initializes a new instance of DocumentExtractionSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/EdgeNGramTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/EdgeNGramTokenizer.cs index f04da3377402..076d1bb1edc4 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/EdgeNGramTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/EdgeNGramTokenizer.cs @@ -26,7 +26,7 @@ public EdgeNGramTokenizer(string name) : base(name) } /// Initializes a new instance of EdgeNGramTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram. /// The maximum n-gram length. Default is 2. Maximum is 300. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/ElisionTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/ElisionTokenFilter.cs index 7b22b8830e0d..0c7c419d6e5a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/ElisionTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/ElisionTokenFilter.cs @@ -26,7 +26,7 @@ public ElisionTokenFilter(string name) : base(name) } /// Initializes a new instance of ElisionTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The set of articles to remove. internal ElisionTokenFilter(string oDataType, string name, IList articles) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityLinkingSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityLinkingSkill.cs index 02681ebd053d..e6c8e05bfa0c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityLinkingSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityLinkingSkill.cs @@ -27,13 +27,13 @@ public EntityLinkingSkill(IEnumerable inputs, IEnumerabl } /// Initializes a new instance of EntityLinkingSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. /// The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. internal EntityLinkingSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, string defaultLanguageCode, double? minimumPrecision, string modelVersion) : base(oDataType, name, description, context, inputs, outputs) @@ -44,7 +44,7 @@ internal EntityLinkingSkill(string oDataType, string name, string description, s ODataType = oDataType ?? "#Microsoft.Skills.Text.V3.EntityLinkingSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public string DefaultLanguageCode { get; set; } /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. public double? MinimumPrecision { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkill.cs index 27630116f595..ec56a0d78cdc 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkill.cs @@ -28,14 +28,14 @@ public EntityRecognitionSkill(IEnumerable inputs, IEnume } /// Initializes a new instance of EntityRecognitionSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. /// A list of entity categories that should be extracted. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced. /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. internal EntityRecognitionSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, IList categories, EntityRecognitionSkillLanguage? defaultLanguageCode, bool? includeTypelessEntities, double? minimumPrecision) : base(oDataType, name, description, context, inputs, outputs) @@ -46,7 +46,7 @@ internal EntityRecognitionSkill(string oDataType, string name, string descriptio MinimumPrecision = minimumPrecision; ODataType = oDataType ?? "#Microsoft.Skills.Text.EntityRecognitionSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public EntityRecognitionSkillLanguage? DefaultLanguageCode { get; set; } /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. public double? MinimumPrecision { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkillV3.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkillV3.cs index 347de076222a..7dc3138df5c6 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkillV3.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/EntityRecognitionSkillV3.cs @@ -28,16 +28,16 @@ public EntityRecognitionSkillV3(IEnumerable inputs, IEnu } /// Initializes a new instance of EntityRecognitionSkillV3. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. /// A list of entity categories that should be extracted. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. - /// The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. + /// The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. internal EntityRecognitionSkillV3(string oDataType, string name, string description, string context, IList inputs, IList outputs, IList categories, string defaultLanguageCode, double? minimumPrecision, string modelVersion) : base(oDataType, name, description, context, inputs, outputs) { Categories = categories; @@ -49,11 +49,11 @@ internal EntityRecognitionSkillV3(string oDataType, string name, string descript /// A list of entity categories that should be extracted. public IList Categories { get; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public string DefaultLanguageCode { get; set; } /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. public double? MinimumPrecision { get; set; } - /// The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. + /// The version of the model to use when calling the Text Analytics API. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. public string ModelVersion { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/HighWaterMarkChangeDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/HighWaterMarkChangeDetectionPolicy.cs index bbe7aba34716..c98b5ad76dee 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/HighWaterMarkChangeDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/HighWaterMarkChangeDetectionPolicy.cs @@ -25,7 +25,7 @@ public HighWaterMarkChangeDetectionPolicy(string highWaterMarkColumnName) } /// Initializes a new instance of HighWaterMarkChangeDetectionPolicy. - /// Identifies the concrete type of the data change detection policy. + /// A URI fragment specifying the type of data change detection policy. /// The name of the high water mark column. internal HighWaterMarkChangeDetectionPolicy(string oDataType, string highWaterMarkColumnName) : base(oDataType) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswParameters.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswParameters.cs index 19c5e59c5b39..24bcc64411e3 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswParameters.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswParameters.cs @@ -7,7 +7,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Contains the parameters specific to hnsw algorithm. + /// Contains the parameters specific to the HNSW algorithm. public partial class HnswParameters { /// Initializes a new instance of HnswParameters. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswVectorSearchAlgorithmConfiguration.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswVectorSearchAlgorithmConfiguration.cs index ca23a8d58736..a2b4ef7d64f4 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswVectorSearchAlgorithmConfiguration.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/HnswVectorSearchAlgorithmConfiguration.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// 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. + /// 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. public partial class HnswVectorSearchAlgorithmConfiguration : VectorSearchAlgorithmConfiguration { /// Initializes a new instance of HnswVectorSearchAlgorithmConfiguration. @@ -26,14 +26,14 @@ public HnswVectorSearchAlgorithmConfiguration(string name) : base(name) /// Initializes a new instance of HnswVectorSearchAlgorithmConfiguration. /// The name to associate with this particular configuration. /// The name of the kind of algorithm being configured for use with vector search. - /// Contains the parameters specific to hnsw algorithm. + /// Contains the parameters specific to HNSW algorithm. internal HnswVectorSearchAlgorithmConfiguration(string name, VectorSearchAlgorithmKind kind, HnswParameters parameters) : base(name, kind) { Parameters = parameters; Kind = kind; } - /// Contains the parameters specific to hnsw algorithm. + /// Contains the parameters specific to HNSW algorithm. public HnswParameters Parameters { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/ImageAnalysisSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/ImageAnalysisSkill.cs index 6ba9e4abb2fb..a71fd58976db 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/ImageAnalysisSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/ImageAnalysisSkill.cs @@ -29,13 +29,13 @@ public ImageAnalysisSkill(IEnumerable inputs, IEnumerabl } /// Initializes a new instance of ImageAnalysisSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A list of visual features. /// A string indicating which domain-specific details to return. internal ImageAnalysisSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, ImageAnalysisSkillLanguage? defaultLanguageCode, IList visualFeatures, IList details) : base(oDataType, name, description, context, inputs, outputs) @@ -46,7 +46,7 @@ internal ImageAnalysisSkill(string oDataType, string name, string description, s ODataType = oDataType ?? "#Microsoft.Skills.Vision.ImageAnalysisSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public ImageAnalysisSkillLanguage? DefaultLanguageCode { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/IndexerExecutionEnvironment.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/IndexerExecutionEnvironment.cs index 70b6c7f668b0..79f1a302cfde 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/IndexerExecutionEnvironment.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/IndexerExecutionEnvironment.cs @@ -25,7 +25,7 @@ public IndexerExecutionEnvironment(string value) private const string StandardValue = "standard"; private const string PrivateValue = "private"; - /// Indicates that Azure Cognitive Search can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. + /// Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. public static IndexerExecutionEnvironment Standard { get; } = new IndexerExecutionEnvironment(StandardValue); /// Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. public static IndexerExecutionEnvironment Private { get; } = new IndexerExecutionEnvironment(PrivateValue); diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/KeepTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/KeepTokenFilter.cs index cd0b0e52bf84..b4fbd7d13b6c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/KeepTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/KeepTokenFilter.cs @@ -29,7 +29,7 @@ public KeepTokenFilter(string name, IEnumerable keepWords) : base(name) } /// Initializes a new instance of KeepTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The list of words to keep. /// A value indicating whether to lower case all words first. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/KeyPhraseExtractionSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/KeyPhraseExtractionSkill.cs index 10b02ebabca0..ee78e3606509 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/KeyPhraseExtractionSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/KeyPhraseExtractionSkill.cs @@ -27,13 +27,13 @@ public KeyPhraseExtractionSkill(IEnumerable inputs, IEnu } /// Initializes a new instance of KeyPhraseExtractionSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. /// The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. internal KeyPhraseExtractionSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, KeyPhraseExtractionSkillLanguage? defaultLanguageCode, int? maxKeyPhraseCount, string modelVersion) : base(oDataType, name, description, context, inputs, outputs) @@ -44,7 +44,7 @@ internal KeyPhraseExtractionSkill(string oDataType, string name, string descript ODataType = oDataType ?? "#Microsoft.Skills.Text.KeyPhraseExtractionSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public KeyPhraseExtractionSkillLanguage? DefaultLanguageCode { get; set; } /// A number indicating how many key phrases to return. If absent, all identified key phrases will be returned. public int? MaxKeyPhraseCount { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/KeywordMarkerTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/KeywordMarkerTokenFilter.cs index d5252f256d96..a615449e4b83 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/KeywordMarkerTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/KeywordMarkerTokenFilter.cs @@ -29,7 +29,7 @@ public KeywordMarkerTokenFilter(string name, IEnumerable keywords) : bas } /// Initializes a new instance of KeywordMarkerTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A list of words to mark as keywords. /// A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LanguageDetectionSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LanguageDetectionSkill.cs index fbcf8f819816..661d05e9602a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LanguageDetectionSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LanguageDetectionSkill.cs @@ -27,7 +27,7 @@ public LanguageDetectionSkill(IEnumerable inputs, IEnume } /// Initializes a new instance of LanguageDetectionSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LengthTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LengthTokenFilter.cs index 3bfcbb4ad231..7e47067205a6 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LengthTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LengthTokenFilter.cs @@ -24,7 +24,7 @@ public LengthTokenFilter(string name) : base(name) } /// Initializes a new instance of LengthTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max. /// The maximum length in characters. Default and maximum is 300. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzer.cs index 47ac38b08b22..75c37ed9b28d 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzer.cs @@ -18,7 +18,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class LexicalAnalyzer { /// Initializes a new instance of LexicalAnalyzer. - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal LexicalAnalyzer(string oDataType, string name) { @@ -26,7 +26,7 @@ internal LexicalAnalyzer(string oDataType, string name) Name = name; } - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. internal string ODataType { get; set; } /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. public string Name { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzerName.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzerName.cs index e4972ca960e9..abee771ece2f 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzerName.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalAnalyzerName.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Defines the names of all text analyzers supported by Azure Cognitive Search. + /// Defines the names of all text analyzers supported by the search engine. public readonly partial struct LexicalAnalyzerName : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizer.cs index cec058d3b20c..513247747b58 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizer.cs @@ -28,7 +28,7 @@ public LexicalNormalizer(string name) } /// Initializes a new instance of LexicalNormalizer. - /// Identifies the concrete type of the normalizer. + /// A URI fragment specifying the type of normalizer. /// The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. internal LexicalNormalizer(string oDataType, string name) { @@ -36,7 +36,7 @@ internal LexicalNormalizer(string oDataType, string name) Name = name; } - /// Identifies the concrete type of the normalizer. + /// A URI fragment specifying the type of normalizer. internal string ODataType { get; set; } /// The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. public string Name { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizerName.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizerName.cs index ae74457d4de9..8d25ceae7f21 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizerName.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalNormalizerName.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Defines the names of all text normalizers supported by Azure Cognitive Search. + /// Defines the names of all text normalizers supported by the search engine. public readonly partial struct LexicalNormalizerName : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizer.cs index 909d238f1146..2a54c081750e 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizer.cs @@ -18,7 +18,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class LexicalTokenizer { /// Initializes a new instance of LexicalTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal LexicalTokenizer(string oDataType, string name) { @@ -26,7 +26,7 @@ internal LexicalTokenizer(string oDataType, string name) Name = name; } - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. internal string ODataType { get; set; } /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. public string Name { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizerName.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizerName.cs index d08de7957883..8f2907816e31 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizerName.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LexicalTokenizerName.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Defines the names of all tokenizers supported by Azure Cognitive Search. + /// Defines the names of all tokenizers supported by the search engine. public readonly partial struct LexicalTokenizerName : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LimitTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LimitTokenFilter.cs index e6beb084d337..ec8ad32b6f1d 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LimitTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LimitTokenFilter.cs @@ -24,7 +24,7 @@ public LimitTokenFilter(string name) : base(name) } /// Initializes a new instance of LimitTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum number of tokens to produce. Default is 1. /// A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/LuceneStandardAnalyzer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/LuceneStandardAnalyzer.cs index fa9a5a979879..81cf1a91938f 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/LuceneStandardAnalyzer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/LuceneStandardAnalyzer.cs @@ -26,7 +26,7 @@ public LuceneStandardAnalyzer(string name) : base(name) } /// Initializes a new instance of LuceneStandardAnalyzer. - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. /// A list of stopwords. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/MappingCharFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/MappingCharFilter.cs index 7f2019965a43..694bc701ad8d 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/MappingCharFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/MappingCharFilter.cs @@ -29,7 +29,7 @@ public MappingCharFilter(string name, IEnumerable mappings) : base(name) } /// Initializes a new instance of MappingCharFilter. - /// Identifies the concrete type of the char filter. + /// A URI fragment specifying the type of char filter. /// The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A list of mappings of the following format: "a=>b" (all occurrences of the character "a" will be replaced with character "b"). internal MappingCharFilter(string oDataType, string name, IList mappings) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/MergeSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/MergeSkill.cs index f461f43f212b..5e0783e6d914 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/MergeSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/MergeSkill.cs @@ -27,7 +27,7 @@ public MergeSkill(IEnumerable inputs, IEnumerable Initializes a new instance of MergeSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageStemmingTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageStemmingTokenizer.cs index e1e29cf7c71b..b48b642986b7 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageStemmingTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageStemmingTokenizer.cs @@ -24,7 +24,7 @@ public MicrosoftLanguageStemmingTokenizer(string name) : base(name) } /// Initializes a new instance of MicrosoftLanguageStemmingTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255. /// A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageTokenizer.cs index 31150345436e..56e8c68a5537 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/MicrosoftLanguageTokenizer.cs @@ -24,7 +24,7 @@ public MicrosoftLanguageTokenizer(string name) : base(name) } /// Initializes a new instance of MicrosoftLanguageTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255. /// A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/NGramTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/NGramTokenizer.cs index 52b44a04ebfe..26e159d6dfe2 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/NGramTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/NGramTokenizer.cs @@ -26,7 +26,7 @@ public NGramTokenizer(string name) : base(name) } /// Initializes a new instance of NGramTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram. /// The maximum n-gram length. Default is 2. Maximum is 300. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/NativeBlobSoftDeleteDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/NativeBlobSoftDeleteDeletionDetectionPolicy.cs index d55005cb6907..522c73ebcd1b 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/NativeBlobSoftDeleteDeletionDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/NativeBlobSoftDeleteDeletionDetectionPolicy.cs @@ -17,7 +17,7 @@ public NativeBlobSoftDeleteDeletionDetectionPolicy() } /// Initializes a new instance of NativeBlobSoftDeleteDeletionDetectionPolicy. - /// Identifies the concrete type of the data deletion detection policy. + /// A URI fragment specifying the type of data deletion detection policy. internal NativeBlobSoftDeleteDeletionDetectionPolicy(string oDataType) : base(oDataType) { ODataType = oDataType ?? "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/OcrSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/OcrSkill.cs index 2579eb483409..3306ca1d50a6 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/OcrSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/OcrSkill.cs @@ -27,13 +27,13 @@ public OcrSkill(IEnumerable inputs, IEnumerable Initializes a new instance of OcrSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A value indicating to turn orientation detection on or not. Default is false. /// Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space". internal OcrSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, OcrSkillLanguage? defaultLanguageCode, bool? shouldDetectOrientation, LineEnding? lineEnding) : base(oDataType, name, description, context, inputs, outputs) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PathHierarchyTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PathHierarchyTokenizer.cs index 0c872fece095..6a7eef630743 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PathHierarchyTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PathHierarchyTokenizer.cs @@ -24,7 +24,7 @@ public PathHierarchyTokenizer(string name) : base(name) } /// Initializes a new instance of PathHierarchyTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The delimiter character to use. Default is "/". /// A value that, if set, replaces the delimiter character. Default is "/". diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternAnalyzer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternAnalyzer.cs index efad388d1f8c..b0235eb173d9 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternAnalyzer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternAnalyzer.cs @@ -26,7 +26,7 @@ public PatternAnalyzer(string name) : base(name) } /// Initializes a new instance of PatternAnalyzer. - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A value indicating whether terms should be lower-cased. Default is true. /// A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternCaptureTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternCaptureTokenFilter.cs index 28c3b78658b1..3135f303bb0c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternCaptureTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternCaptureTokenFilter.cs @@ -29,7 +29,7 @@ public PatternCaptureTokenFilter(string name, IEnumerable patterns) : ba } /// Initializes a new instance of PatternCaptureTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A list of patterns to match against each token. /// A value indicating whether to return the original token even if one of the patterns matches. Default is true. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceCharFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceCharFilter.cs index e5e429ea7dcc..ad50fc627c40 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceCharFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceCharFilter.cs @@ -30,7 +30,7 @@ public PatternReplaceCharFilter(string name, string pattern, string replacement) } /// Initializes a new instance of PatternReplaceCharFilter. - /// Identifies the concrete type of the char filter. + /// A URI fragment specifying the type of char filter. /// The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A regular expression pattern. /// The replacement text. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceTokenFilter.cs index 65b9d14b0a33..c77c0d0e4ec9 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternReplaceTokenFilter.cs @@ -30,7 +30,7 @@ public PatternReplaceTokenFilter(string name, string pattern, string replacement } /// Initializes a new instance of PatternReplaceTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A regular expression pattern. /// The replacement text. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternTokenizer.cs index 9794cff30266..ccf7bdc7da83 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PatternTokenizer.cs @@ -24,7 +24,7 @@ public PatternTokenizer(string name) : base(name) } /// Initializes a new instance of PatternTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters. /// Regular expression flags. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PhoneticTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PhoneticTokenFilter.cs index e595644fa99e..54b792f69a4e 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PhoneticTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PhoneticTokenFilter.cs @@ -24,7 +24,7 @@ public PhoneticTokenFilter(string name) : base(name) } /// Initializes a new instance of PhoneticTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The phonetic encoder to use. Default is "metaphone". /// A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/PiiDetectionSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/PiiDetectionSkill.cs index e011a8d6f904..76047fed800c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/PiiDetectionSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/PiiDetectionSkill.cs @@ -28,13 +28,13 @@ public PiiDetectionSkill(IEnumerable inputs, IEnumerable } /// Initializes a new instance of PiiDetectionSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included. /// A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. /// The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryAnswerType.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryAnswerType.cs index 991483f70ab2..01087c28d138 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryAnswerType.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryAnswerType.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Models { - /// This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-<number of answers>' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-<confidence threshold>' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7. + /// This parameter is only valid if the query type is `semantic`. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character `|` followed by the `count-<number of answers>` option after the answers parameter value, such as `extractive|count-3`. Default count is 1. The confidence threshold can be configured by appending the pipe character `|` followed by the `threshold-<confidence threshold>` option after the answers parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. public readonly partial struct QueryAnswerType : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryCaptionType.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryCaptionType.cs index bd8dfe0c31f8..bee994a7a236 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryCaptionType.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryCaptionType.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Models { - /// This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-<true/false>' option, such as 'extractive|highlight-true'. Defaults to 'None'. + /// This parameter is only valid if the query type is `semantic`. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to `extractive`, highlighting is enabled by default, and can be configured by appending the pipe character `|` followed by the `highlight-<true/false>` option, such as `extractive|highlight-true`. Defaults to `None`. public readonly partial struct QueryCaptionType : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryDebugMode.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryDebugMode.cs index 22959e46776b..8b4086ae2e7a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryDebugMode.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryDebugMode.cs @@ -27,7 +27,7 @@ public QueryDebugMode(string value) /// No query debugging information will be returned. public static QueryDebugMode Disabled { get; } = new QueryDebugMode(DisabledValue); - /// Allows the user to further explore their Semantic search results. + /// Allows the user to further explore their reranked results. public static QueryDebugMode Semantic { get; } = new QueryDebugMode(SemanticValue); /// Determines if two values are the same. public static bool operator ==(QueryDebugMode left, QueryDebugMode right) => left.Equals(right); diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryLanguage.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryLanguage.cs index e65fc310e0b0..187baef7a9e8 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryLanguage.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/QueryLanguage.cs @@ -197,7 +197,7 @@ public QueryLanguage(string value) public static QueryLanguage LvLv { get; } = new QueryLanguage(LvLvValue); /// Query language value for Estonian (Estonia). public static QueryLanguage EtEe { get; } = new QueryLanguage(EtEeValue); - /// Query language value for Catalan (Spain). + /// Query language value for Catalan. public static QueryLanguage CaEs { get; } = new QueryLanguage(CaEsValue); /// Query language value for Finnish (Finland). public static QueryLanguage FiFi { get; } = new QueryLanguage(FiFiValue); @@ -215,9 +215,9 @@ public QueryLanguage(string value) public static QueryLanguage HyAm { get; } = new QueryLanguage(HyAmValue); /// Query language value for Bengali (India). public static QueryLanguage BnIn { get; } = new QueryLanguage(BnInValue); - /// Query language value for Basque (Spain). + /// Query language value for Basque. public static QueryLanguage EuEs { get; } = new QueryLanguage(EuEsValue); - /// Query language value for Galician (Spain). + /// Query language value for Galician. public static QueryLanguage GlEs { get; } = new QueryLanguage(GlEsValue); /// Query language value for Gujarati (India). public static QueryLanguage GuIn { get; } = new QueryLanguage(GuInValue); diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchDocumentsResult.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchDocumentsResult.cs index 30cf7c8d0867..18d223776e8a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchDocumentsResult.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchDocumentsResult.cs @@ -29,15 +29,15 @@ internal SearchDocumentsResult(IEnumerable results) } /// Initializes a new instance of SearchDocumentsResult. - /// The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response. + /// The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if the query can't return all the requested documents in a single response. /// A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. /// The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions. /// The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. - /// Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. - /// Reason that a partial response was returned for a semantic search request. - /// Type of partial response that was returned for a semantic search request. + /// Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. + /// Reason that a partial response was returned for a semantic ranking request. + /// Type of partial response that was returned for a semantic ranking request. /// The sequence of results returned by the query. - /// Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. + /// Continuation URL returned when the query can't return all the requested results in a single response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. internal SearchDocumentsResult(long? count, double? coverage, IReadOnlyDictionary> facets, IReadOnlyList answers, SearchOptions nextPageParameters, SemanticPartialResponseReason? semanticPartialResponseReason, SemanticPartialResponseType? semanticPartialResponseType, IReadOnlyList results, string nextLink) { Count = count; @@ -51,7 +51,7 @@ internal SearchDocumentsResult(long? count, double? coverage, IReadOnlyDictionar NextLink = nextLink; } - /// The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response. + /// The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if the query can't return all the requested documents in a single response. public long? Count { get; } /// A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. public double? Coverage { get; } @@ -59,15 +59,15 @@ internal SearchDocumentsResult(long? count, double? coverage, IReadOnlyDictionar public IReadOnlyDictionary> Facets { get; } /// The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. public IReadOnlyList Answers { get; } - /// Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. + /// Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. public SearchOptions NextPageParameters { get; } - /// Reason that a partial response was returned for a semantic search request. + /// Reason that a partial response was returned for a semantic ranking request. public SemanticPartialResponseReason? SemanticPartialResponseReason { get; } - /// Type of partial response that was returned for a semantic search request. + /// Type of partial response that was returned for a semantic ranking request. public SemanticPartialResponseType? SemanticPartialResponseType { get; } /// The sequence of results returned by the query. public IReadOnlyList Results { get; } - /// Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. + /// Continuation URL returned when the query can't return all the requested results in a single response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. public string NextLink { get; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchError.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchError.cs index deabe9ca0a18..c585d55ccf79 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchError.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchError.cs @@ -11,7 +11,7 @@ namespace Azure.Search.Documents.Models { - /// Describes an error condition for the Azure Cognitive Search API. + /// Describes an error condition for the API. internal partial class SearchError { /// Initializes a new instance of SearchError. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchField.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchField.cs index ca0d379fad7b..f19104cd1d6d 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchField.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchField.cs @@ -19,9 +19,9 @@ public partial class SearchField /// The data type of the field. /// A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. /// A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields. - /// A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. + /// A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. /// A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. - /// A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. + /// A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. /// A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. /// The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. /// The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndex.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndex.cs index 199f18235cd1..bce20250f509 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndex.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndex.cs @@ -47,7 +47,7 @@ public partial class SearchIndex /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include . /// - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. /// /// The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. @@ -79,7 +79,7 @@ internal SearchIndex(string name, IList fields, IList Options to control Cross-Origin Resource Sharing (CORS) for the index. public CorsOptions CorsOptions { get; set; } - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. public SearchResourceEncryptionKey EncryptionKey { get; set; } /// /// The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexer.cs index 80ff9936000a..3abe0ce65d85 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexer.cs @@ -44,7 +44,7 @@ public SearchIndexer(string name, string dataSourceName, string targetIndexName) /// Output field mappings are applied after enrichment and immediately before indexing. /// A value indicating whether the indexer is disabled. Default is false. /// The ETag of the indexer. - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. /// Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. internal SearchIndexer(string name, string description, string dataSourceName, string skillsetName, string targetIndexName, IndexingSchedule schedule, IndexingParameters parameters, IList fieldMappings, IList outputFieldMappings, bool? isDisabled, string etag, SearchResourceEncryptionKey encryptionKey, SearchIndexerCache cache) { @@ -79,7 +79,7 @@ internal SearchIndexer(string name, string description, string dataSourceName, s public IndexingParameters Parameters { get; set; } /// A value indicating whether the indexer is disabled. Default is false. public bool? IsDisabled { get; set; } - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. public SearchResourceEncryptionKey EncryptionKey { get; set; } /// Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. public SearchIndexerCache Cache { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataIdentity.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataIdentity.cs index e03a3017f5f9..797a977fa574 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataIdentity.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataIdentity.cs @@ -20,13 +20,13 @@ public SearchIndexerDataIdentity() } /// Initializes a new instance of SearchIndexerDataIdentity. - /// Identifies the concrete type of the identity. + /// A URI fragment specifying the type of identity. internal SearchIndexerDataIdentity(string oDataType) { ODataType = oDataType; } - /// Identifies the concrete type of the identity. + /// A URI fragment specifying the type of identity. internal string ODataType { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataNoneIdentity.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataNoneIdentity.cs index 2721d9b058de..c218d1fde7bc 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataNoneIdentity.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataNoneIdentity.cs @@ -17,7 +17,7 @@ public SearchIndexerDataNoneIdentity() } /// Initializes a new instance of SearchIndexerDataNoneIdentity. - /// Identifies the concrete type of the identity. + /// A URI fragment specifying the type of identity. internal SearchIndexerDataNoneIdentity(string oDataType) : base(oDataType) { ODataType = oDataType ?? "#Microsoft.Azure.Search.DataNoneIdentity"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataSourceConnection.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataSourceConnection.cs index 54975b0e4593..e33c1b21684a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataSourceConnection.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataSourceConnection.cs @@ -35,7 +35,7 @@ public partial class SearchIndexerDataSourceConnection /// The available derived classes include and . /// /// The ETag of the data source. - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. internal SearchIndexerDataSourceConnection(string name, string description, SearchIndexerDataSourceType type, DataSourceCredentials credentialsInternal, SearchIndexerDataContainer container, SearchIndexerDataIdentity identity, DataChangeDetectionPolicy dataChangeDetectionPolicy, DataDeletionDetectionPolicy dataDeletionDetectionPolicy, string etag, SearchResourceEncryptionKey encryptionKey) { Name = name; @@ -76,7 +76,7 @@ internal SearchIndexerDataSourceConnection(string name, string description, Sear /// The available derived classes include and . /// public DataDeletionDetectionPolicy DataDeletionDetectionPolicy { get; set; } - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. public SearchResourceEncryptionKey EncryptionKey { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataUserAssignedIdentity.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataUserAssignedIdentity.cs index 4f2e017b383b..a528dd2a0b47 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataUserAssignedIdentity.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerDataUserAssignedIdentity.cs @@ -25,7 +25,7 @@ public SearchIndexerDataUserAssignedIdentity(string userAssignedIdentity) } /// Initializes a new instance of SearchIndexerDataUserAssignedIdentity. - /// Identifies the concrete type of the identity. + /// A URI fragment specifying the type of identity. /// The fully qualified Azure resource Id of a user assigned managed identity typically in the form "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" that should have been assigned to the search service. internal SearchIndexerDataUserAssignedIdentity(string oDataType, string userAssignedIdentity) : base(oDataType) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkill.cs index fda5442057a1..6b4236fbf2ea 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkill.cs @@ -20,7 +20,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class SearchIndexerSkill { /// Initializes a new instance of SearchIndexerSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. @@ -36,7 +36,7 @@ internal SearchIndexerSkill(string oDataType, string name, string description, s Outputs = outputs; } - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. internal string ODataType { get; set; } /// The description of the skill which describes the inputs, outputs, and usage of the skill. public string Description { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkillset.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkillset.cs index 18f36c4d9153..198139dce896 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkillset.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchIndexerSkillset.cs @@ -41,14 +41,14 @@ public SearchIndexerSkillset(string name, IEnumerable skills /// The available derived classes include , , , , , , , , , , , , , , , , , , and . /// /// - /// Details about cognitive services to be used when running skills. + /// Details about the Azure AI service to be used when running skills. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// - /// Definition of additional projections to azure blob, table, or files, of enriched data. + /// Definition of additional projections to Azure blob, table, or files, of enriched data. /// Definition of additional projections to secondary search index(es). /// The ETag of the skillset. - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure Cognitive Search. Once you have encrypted your skillset definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. internal SearchIndexerSkillset(string name, string description, IList skills, CognitiveServicesAccount cognitiveServicesAccount, KnowledgeStore knowledgeStore, SearchIndexerIndexProjections indexProjections, string etag, SearchResourceEncryptionKey encryptionKey) { Name = name; @@ -66,16 +66,16 @@ internal SearchIndexerSkillset(string name, string description, IList The description of the skillset. public string Description { get; set; } /// - /// Details about cognitive services to be used when running skills. + /// Details about the Azure AI service to be used when running skills. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// public CognitiveServicesAccount CognitiveServicesAccount { get; set; } - /// Definition of additional projections to azure blob, table, or files, of enriched data. + /// Definition of additional projections to Azure blob, table, or files, of enriched data. public KnowledgeStore KnowledgeStore { get; set; } /// Definition of additional projections to secondary search index(es). public SearchIndexerIndexProjections IndexProjections { get; set; } - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure Cognitive Search. Once you have encrypted your skillset definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. public SearchResourceEncryptionKey EncryptionKey { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchOptions.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchOptions.cs index 8dcaef2dc815..6fa084e12769 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchOptions.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchOptions.cs @@ -40,7 +40,7 @@ public SearchOptions() /// The name of a semantic configuration that will be used when processing documents for queries of type semantic. /// Allows the user to choose whether a semantic call should fail completely, or to return partial results (default). /// Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. - /// Enables a debugging tool that can be used to further explore your Semantic search results. + /// Enables a debugging tool that can be used to further explore your reranked results. /// A full-text search query expression; Use "*" or omit this parameter to match all documents. /// The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter. /// A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. @@ -51,7 +51,7 @@ public SearchOptions() /// The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead. /// The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results. /// A value that specifies whether captions should be returned as part of the search response. - /// The comma-separated list of field names used for semantic search. + /// The comma-separated list of field names used for semantic ranking. /// /// The query parameters for vector and hybrid search queries. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. @@ -112,7 +112,7 @@ internal SearchOptions(bool? includeTotalCount, IList facets, string fil public SemanticErrorHandling? SemanticErrorHandling { get; set; } /// Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. public int? SemanticMaxWaitInMilliseconds { get; set; } - /// Enables a debugging tool that can be used to further explore your Semantic search results. + /// Enables a debugging tool that can be used to further explore your reranked results. public QueryDebugMode? Debug { get; set; } /// A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. public SearchMode? SearchMode { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchResourceEncryptionKey.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchResourceEncryptionKey.cs index 15d7984477b9..0d2b9a0460c4 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchResourceEncryptionKey.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchResourceEncryptionKey.cs @@ -10,13 +10,13 @@ namespace Azure.Search.Documents.Indexes.Models { - /// A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps. + /// A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest, such as indexes and synonym maps. public partial class SearchResourceEncryptionKey { /// Initializes a new instance of SearchResourceEncryptionKey. /// The name of your Azure Key Vault key to be used to encrypt your data at rest. /// The version of your Azure Key Vault key to be used to encrypt your data at rest. - /// The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net. + /// The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. /// Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. /// /// An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchServiceError.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchServiceError.cs index 4bbb91edbfe2..58284f5b4c26 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchServiceError.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SearchServiceError.cs @@ -11,7 +11,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Describes an error condition for the Azure Cognitive Search API. + /// Describes an error condition for the API. internal partial class SearchServiceError { /// Initializes a new instance of SearchServiceError. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseReason.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseReason.cs index 55bff652a218..87b74286fa7a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseReason.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseReason.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Models { - /// Reason that a partial response was returned for a semantic search request. + /// Reason that a partial response was returned for a semantic ranking request. public readonly partial struct SemanticPartialResponseReason : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseType.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseType.cs index 3a87faa4f1e6..82d76fc0c1ef 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseType.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SemanticPartialResponseType.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Models { - /// Type of partial response that was returned for a semantic search request. + /// Type of partial response that was returned for a semantic ranking request. public readonly partial struct SemanticPartialResponseType : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkill.cs index 8a89c9fa7159..069adca3f40b 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkill.cs @@ -27,13 +27,13 @@ public SentimentSkill(IEnumerable inputs, IEnumerable Initializes a new instance of SentimentSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. internal SentimentSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, SentimentSkillLanguage? defaultLanguageCode) : base(oDataType, name, description, context, inputs, outputs) { DefaultLanguageCode = defaultLanguageCode; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkillV3.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkillV3.cs index bd62ee0b9c95..658a6c6204d1 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkillV3.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SentimentSkillV3.cs @@ -27,13 +27,13 @@ public SentimentSkillV3(IEnumerable inputs, IEnumerable< } /// Initializes a new instance of SentimentSkillV3. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false. /// The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary. internal SentimentSkillV3(string oDataType, string name, string description, string context, IList inputs, IList outputs, string defaultLanguageCode, bool? includeOpinionMining, string modelVersion) : base(oDataType, name, description, context, inputs, outputs) @@ -44,7 +44,7 @@ internal SentimentSkillV3(string oDataType, string name, string description, str ODataType = oDataType ?? "#Microsoft.Skills.Text.V3.SentimentSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public string DefaultLanguageCode { get; set; } /// If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false. public bool? IncludeOpinionMining { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/ShaperSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/ShaperSkill.cs index 395da913b3ac..4def23ac9b78 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/ShaperSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/ShaperSkill.cs @@ -27,7 +27,7 @@ public ShaperSkill(IEnumerable inputs, IEnumerable Initializes a new instance of ShaperSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/ShingleTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/ShingleTokenFilter.cs index ae31c77cb10b..4fbd67075bf3 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/ShingleTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/ShingleTokenFilter.cs @@ -24,7 +24,7 @@ public ShingleTokenFilter(string name) : base(name) } /// Initializes a new instance of ShingleTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum shingle size. Default and minimum value is 2. /// The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SnowballTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SnowballTokenFilter.cs index a9c1ff7f61b4..36d301a41a17 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SnowballTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SnowballTokenFilter.cs @@ -26,7 +26,7 @@ public SnowballTokenFilter(string name, SnowballTokenFilterLanguage language) : } /// Initializes a new instance of SnowballTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The language to use. internal SnowballTokenFilter(string oDataType, string name, SnowballTokenFilterLanguage language) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SoftDeleteColumnDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SoftDeleteColumnDeletionDetectionPolicy.cs index 8b0fc95fa3bb..34104b538a5f 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SoftDeleteColumnDeletionDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SoftDeleteColumnDeletionDetectionPolicy.cs @@ -17,7 +17,7 @@ public SoftDeleteColumnDeletionDetectionPolicy() } /// Initializes a new instance of SoftDeleteColumnDeletionDetectionPolicy. - /// Identifies the concrete type of the data deletion detection policy. + /// A URI fragment specifying the type of data deletion detection policy. /// The name of the column to use for soft-deletion detection. /// The marker value that identifies an item as deleted. internal SoftDeleteColumnDeletionDetectionPolicy(string oDataType, string softDeleteColumnName, string softDeleteMarkerValue) : base(oDataType) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SplitSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SplitSkill.cs index d45130ff5768..137f05955af0 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SplitSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SplitSkill.cs @@ -27,13 +27,13 @@ public SplitSkill(IEnumerable inputs, IEnumerable Initializes a new instance of SplitSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. /// Inputs of the skills could be a column in the source data set, or the output of an upstream skill. /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. /// A value indicating which split mode to perform. /// The desired maximum page length. Default is 10000. /// Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk will start with this number of characters/tokens from the end of the nth chunk. @@ -48,7 +48,7 @@ internal SplitSkill(string oDataType, string name, string description, string co ODataType = oDataType ?? "#Microsoft.Skills.Text.SplitSkill"; } - /// A value indicating which language code to use. Default is en. + /// A value indicating which language code to use. Default is `en`. public SplitSkillLanguage? DefaultLanguageCode { get; set; } /// A value indicating which split mode to perform. public TextSplitMode? TextSplitMode { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SqlIntegratedChangeTrackingPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SqlIntegratedChangeTrackingPolicy.cs index e2dee9e46202..c8cdf43536d8 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SqlIntegratedChangeTrackingPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SqlIntegratedChangeTrackingPolicy.cs @@ -17,7 +17,7 @@ public SqlIntegratedChangeTrackingPolicy() } /// Initializes a new instance of SqlIntegratedChangeTrackingPolicy. - /// Identifies the concrete type of the data change detection policy. + /// A URI fragment specifying the type of data change detection policy. internal SqlIntegratedChangeTrackingPolicy(string oDataType) : base(oDataType) { ODataType = oDataType ?? "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerOverrideTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerOverrideTokenFilter.cs index 4da5daa9a46e..cadbc2d4339f 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerOverrideTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerOverrideTokenFilter.cs @@ -29,7 +29,7 @@ public StemmerOverrideTokenFilter(string name, IEnumerable rules) : base } /// Initializes a new instance of StemmerOverrideTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A list of stemming rules in the following format: "word => stem", for example: "ran => run". internal StemmerOverrideTokenFilter(string oDataType, string name, IList rules) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerTokenFilter.cs index abd12474d006..65c045267a88 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/StemmerTokenFilter.cs @@ -26,7 +26,7 @@ public StemmerTokenFilter(string name, StemmerTokenFilterLanguage language) : ba } /// Initializes a new instance of StemmerTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The language to use. internal StemmerTokenFilter(string oDataType, string name, StemmerTokenFilterLanguage language) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/StopAnalyzer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/StopAnalyzer.cs index bb7d23b4ab25..061fa655f8b6 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/StopAnalyzer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/StopAnalyzer.cs @@ -26,7 +26,7 @@ public StopAnalyzer(string name) : base(name) } /// Initializes a new instance of StopAnalyzer. - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A list of stopwords. internal StopAnalyzer(string oDataType, string name, IList stopwords) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/StopwordsTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/StopwordsTokenFilter.cs index f73a6fe574f3..81260361ba9a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/StopwordsTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/StopwordsTokenFilter.cs @@ -26,7 +26,7 @@ public StopwordsTokenFilter(string name) : base(name) } /// Initializes a new instance of StopwordsTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The list of stopwords. This property and the stopwords list property cannot both be set. /// A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymMap.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymMap.cs index 8d83c5d8ff18..9b4a4f5dbc5a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymMap.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymMap.cs @@ -17,7 +17,7 @@ public partial class SynonymMap /// The name of the synonym map. /// The format of the synonym map. Only the 'solr' format is currently supported. /// A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. /// The ETag of the synonym map. internal SynonymMap(string name, string format, string synonyms, SearchResourceEncryptionKey encryptionKey, string etag) { @@ -32,7 +32,7 @@ internal SynonymMap(string name, string format, string synonyms, SearchResourceE public string Name { get; set; } /// A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. public string Synonyms { get; set; } - /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. + /// A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. public SearchResourceEncryptionKey EncryptionKey { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymTokenFilter.cs index b198a31bbeea..1f7c2980d297 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/SynonymTokenFilter.cs @@ -29,7 +29,7 @@ public SynonymTokenFilter(string name, IEnumerable synonyms) : base(name } /// Initializes a new instance of SynonymTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted. /// A value indicating whether to case-fold input for matching. Default is false. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/TextTranslationSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/TextTranslationSkill.cs index 3d6ed25284a8..c6270cc7f4a0 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/TextTranslationSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/TextTranslationSkill.cs @@ -29,7 +29,7 @@ public TextTranslationSkill(IEnumerable inputs, IEnumera } /// Initializes a new instance of TextTranslationSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. @@ -37,7 +37,7 @@ public TextTranslationSkill(IEnumerable inputs, IEnumera /// The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. /// The language code to translate documents into for documents that don't specify the to language explicitly. /// The language code to translate documents from for documents that don't specify the from language explicitly. - /// The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en. + /// The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is `en`. internal TextTranslationSkill(string oDataType, string name, string description, string context, IList inputs, IList outputs, TextTranslationSkillLanguage defaultToLanguageCode, TextTranslationSkillLanguage? defaultFromLanguageCode, TextTranslationSkillLanguage? suggestedFrom) : base(oDataType, name, description, context, inputs, outputs) { DefaultToLanguageCode = defaultToLanguageCode; @@ -50,7 +50,7 @@ internal TextTranslationSkill(string oDataType, string name, string description, public TextTranslationSkillLanguage DefaultToLanguageCode { get; set; } /// The language code to translate documents from for documents that don't specify the from language explicitly. public TextTranslationSkillLanguage? DefaultFromLanguageCode { get; set; } - /// The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en. + /// The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is `en`. public TextTranslationSkillLanguage? SuggestedFrom { get; set; } } } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilter.cs index 0b5b5aeaad18..e3f2dbb46de3 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilter.cs @@ -18,7 +18,7 @@ namespace Azure.Search.Documents.Indexes.Models public partial class TokenFilter { /// Initializes a new instance of TokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal TokenFilter(string oDataType, string name) { @@ -26,7 +26,7 @@ internal TokenFilter(string oDataType, string name) Name = name; } - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. internal string ODataType { get; set; } /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. public string Name { get; set; } diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilterName.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilterName.cs index a0bf4465ae73..39a8f4925be2 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilterName.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/TokenFilterName.cs @@ -10,7 +10,7 @@ namespace Azure.Search.Documents.Indexes.Models { - /// Defines the names of all token filters supported by Azure Cognitive Search. + /// Defines the names of all token filters supported by the search engine. public readonly partial struct TokenFilterName : IEquatable { private readonly string _value; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/TruncateTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/TruncateTokenFilter.cs index 2833612553cc..92e0dc6156e7 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/TruncateTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/TruncateTokenFilter.cs @@ -24,7 +24,7 @@ public TruncateTokenFilter(string name) : base(name) } /// Initializes a new instance of TruncateTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The length at which terms will be truncated. Default and maximum is 300. internal TruncateTokenFilter(string oDataType, string name, int? length) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UaxUrlEmailTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UaxUrlEmailTokenizer.cs index e90081382c9e..4112fb984ab7 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UaxUrlEmailTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UaxUrlEmailTokenizer.cs @@ -24,7 +24,7 @@ public UaxUrlEmailTokenizer(string name) : base(name) } /// Initializes a new instance of UaxUrlEmailTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters. internal UaxUrlEmailTokenizer(string oDataType, string name, int? maxTokenLength) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UniqueTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UniqueTokenFilter.cs index 31a7aa5d8695..adf2195c5c05 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UniqueTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UniqueTokenFilter.cs @@ -24,7 +24,7 @@ public UniqueTokenFilter(string name) : base(name) } /// Initializes a new instance of UniqueTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A value indicating whether to remove duplicates only at the same position. Default is false. internal UniqueTokenFilter(string oDataType, string name, bool? onlyOnSamePosition) : base(oDataType, name) diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCharFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCharFilter.cs index e77044617c59..efb1a8c6c5da 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCharFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCharFilter.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownCharFilter : CharFilter { /// Initializes a new instance of UnknownCharFilter. - /// Identifies the concrete type of the char filter. + /// A URI fragment specifying the type of char filter. /// The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal UnknownCharFilter(string oDataType, string name) : base(oDataType, name) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCognitiveServicesAccount.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCognitiveServicesAccount.cs index 06052b21b3f9..6b8cabf3a3be 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCognitiveServicesAccount.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownCognitiveServicesAccount.cs @@ -13,8 +13,8 @@ namespace Azure.Search.Documents.Models internal partial class UnknownCognitiveServicesAccount : CognitiveServicesAccount { /// Initializes a new instance of UnknownCognitiveServicesAccount. - /// Identifies the concrete type of the cognitive service resource attached to a skillset. - /// Description of the cognitive service resource attached to a skillset. + /// A URI fragment specifying the type of Azure AI service resource attached to a skillset. + /// Description of the Azure AI service resource attached to a skillset. internal UnknownCognitiveServicesAccount(string oDataType, string description) : base(oDataType, description) { ODataType = oDataType ?? "Unknown"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataChangeDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataChangeDetectionPolicy.cs index ba19695e8c54..9189d3079f70 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataChangeDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataChangeDetectionPolicy.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownDataChangeDetectionPolicy : DataChangeDetectionPolicy { /// Initializes a new instance of UnknownDataChangeDetectionPolicy. - /// Identifies the concrete type of the data change detection policy. + /// A URI fragment specifying the type of data change detection policy. internal UnknownDataChangeDetectionPolicy(string oDataType) : base(oDataType) { ODataType = oDataType ?? "Unknown"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataDeletionDetectionPolicy.cs index 08fcff8740df..b123ba8e6a90 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataDeletionDetectionPolicy.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownDataDeletionDetectionPolicy.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownDataDeletionDetectionPolicy : DataDeletionDetectionPolicy { /// Initializes a new instance of UnknownDataDeletionDetectionPolicy. - /// Identifies the concrete type of the data deletion detection policy. + /// A URI fragment specifying the type of data deletion detection policy. internal UnknownDataDeletionDetectionPolicy(string oDataType) : base(oDataType) { ODataType = oDataType ?? "Unknown"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalAnalyzer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalAnalyzer.cs index 95f618fa9a8e..a764e96b97fc 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalAnalyzer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalAnalyzer.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownLexicalAnalyzer : LexicalAnalyzer { /// Initializes a new instance of UnknownLexicalAnalyzer. - /// Identifies the concrete type of the analyzer. + /// A URI fragment specifying the type of analyzer. /// The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal UnknownLexicalAnalyzer(string oDataType, string name) : base(oDataType, name) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalNormalizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalNormalizer.cs index 8244eb9cfdb7..9e5071e670fe 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalNormalizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalNormalizer.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownLexicalNormalizer : LexicalNormalizer { /// Initializes a new instance of UnknownLexicalNormalizer. - /// Identifies the concrete type of the normalizer. + /// A URI fragment specifying the type of normalizer. /// The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. internal UnknownLexicalNormalizer(string oDataType, string name) : base(oDataType, name) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalTokenizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalTokenizer.cs index 424474efeb23..826e1d3a165a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalTokenizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownLexicalTokenizer.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownLexicalTokenizer : LexicalTokenizer { /// Initializes a new instance of UnknownLexicalTokenizer. - /// Identifies the concrete type of the tokenizer. + /// A URI fragment specifying the type of tokenizer. /// The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal UnknownLexicalTokenizer(string oDataType, string name) : base(oDataType, name) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerDataIdentity.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerDataIdentity.cs index edf89be8e742..a8d3d922990c 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerDataIdentity.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerDataIdentity.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownSearchIndexerDataIdentity : SearchIndexerDataIdentity { /// Initializes a new instance of UnknownSearchIndexerDataIdentity. - /// Identifies the concrete type of the identity. + /// A URI fragment specifying the type of identity. internal UnknownSearchIndexerDataIdentity(string oDataType) : base(oDataType) { ODataType = oDataType ?? "Unknown"; diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerSkill.cs index ddd685b9ac10..4bcc4302107e 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownSearchIndexerSkill.cs @@ -14,7 +14,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownSearchIndexerSkill : SearchIndexerSkill { /// Initializes a new instance of UnknownSearchIndexerSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownTokenFilter.cs index 0308f9d131e8..f719581d4c54 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/UnknownTokenFilter.cs @@ -13,7 +13,7 @@ namespace Azure.Search.Documents.Models internal partial class UnknownTokenFilter : TokenFilter { /// Initializes a new instance of UnknownTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. internal UnknownTokenFilter(string oDataType, string name) : base(oDataType, name) { diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearch.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearch.cs index 40f70e4024f3..c1f5218504fc 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearch.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearch.cs @@ -24,7 +24,7 @@ public VectorSearch() /// Initializes a new instance of VectorSearch. /// Defines combinations of configurations to use with vector search. /// - /// Contains configuration options specific to the algorithm used during indexing and/or querying. + /// Contains configuration options specific to the algorithm used during indexing or querying. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// @@ -43,7 +43,7 @@ internal VectorSearch(IList profiles, IList Defines combinations of configurations to use with vector search. public IList Profiles { get; } /// - /// Contains configuration options specific to the algorithm used during indexing and/or querying. + /// Contains configuration options specific to the algorithm used during indexing or querying. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmConfiguration.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmConfiguration.cs index cb8de30164da..e20e3495c8b5 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmConfiguration.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmConfiguration.cs @@ -11,7 +11,7 @@ namespace Azure.Search.Documents.Indexes.Models { /// - /// Contains configuration options specific to the algorithm used during indexing and/or querying. + /// Contains configuration options specific to the algorithm used during indexing or querying. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmKind.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmKind.cs index c12d23f8499f..1dba4d696557 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmKind.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchAlgorithmKind.cs @@ -25,7 +25,7 @@ public VectorSearchAlgorithmKind(string value) private const string HnswValue = "hnsw"; private const string ExhaustiveKnnValue = "exhaustiveKnn"; - /// Hnsw (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. + /// HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. public static VectorSearchAlgorithmKind Hnsw { get; } = new VectorSearchAlgorithmKind(HnswValue); /// Exhaustive KNN algorithm which will perform brute-force search. public static VectorSearchAlgorithmKind ExhaustiveKnn { get; } = new VectorSearchAlgorithmKind(ExhaustiveKnnValue); diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizer.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizer.cs index 2905d0d2ae7a..3ed0df93f031 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizer.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizer.cs @@ -11,7 +11,7 @@ namespace Azure.Search.Documents.Indexes.Models { /// - /// Contains specific details for a vectorization method to be used during query time. + /// Specifies the vectorization method to be used during query time. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizerKind.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizerKind.cs index 32873ccfea0e..347dd38d33fe 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizerKind.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/VectorSearchVectorizerKind.cs @@ -25,7 +25,7 @@ public VectorSearchVectorizerKind(string value) private const string AzureOpenAIValue = "azureOpenAI"; private const string CustomWebApiValue = "customWebApi"; - /// Generate embeddings using an Azure Open AI service at query time. + /// Generate embeddings using an Azure OpenAI resource at query time. public static VectorSearchVectorizerKind AzureOpenAI { get; } = new VectorSearchVectorizerKind(AzureOpenAIValue); /// Generate embeddings using a custom web endpoint at query time. public static VectorSearchVectorizerKind CustomWebApi { get; } = new VectorSearchVectorizerKind(CustomWebApiValue); diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/WebApiSkill.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/WebApiSkill.cs index c1e02c1e2b03..36aad8d4613a 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/WebApiSkill.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/WebApiSkill.cs @@ -31,7 +31,7 @@ public WebApiSkill(IEnumerable inputs, IEnumerable Initializes a new instance of WebApiSkill. - /// Identifies the concrete type of the skill. + /// A URI fragment specifying the type of skill. /// The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. /// The description of the skill which describes the inputs, outputs, and usage of the skill. /// Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/Models/WordDelimiterTokenFilter.cs b/sdk/search/Azure.Search.Documents/src/Generated/Models/WordDelimiterTokenFilter.cs index 98ccfbde7c6c..33ef640ca01b 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/Models/WordDelimiterTokenFilter.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/Models/WordDelimiterTokenFilter.cs @@ -26,7 +26,7 @@ public WordDelimiterTokenFilter(string name) : base(name) } /// Initializes a new instance of WordDelimiterTokenFilter. - /// Identifies the concrete type of the token filter. + /// A URI fragment specifying the type of token filter. /// The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. /// A value indicating whether to generate part words. If set, causes parts of words to be generated; for example "AzureSearch" becomes "Azure" "Search". Default is true. /// A value indicating whether to generate number subwords. Default is true. diff --git a/sdk/search/Azure.Search.Documents/src/Generated/SearchModelFactory.cs b/sdk/search/Azure.Search.Documents/src/Generated/SearchModelFactory.cs index 02f2798fe1d1..16d3b8560595 100644 --- a/sdk/search/Azure.Search.Documents/src/Generated/SearchModelFactory.cs +++ b/sdk/search/Azure.Search.Documents/src/Generated/SearchModelFactory.cs @@ -15,84 +15,6 @@ namespace Azure.Search.Documents.Models /// Model factory for models. public static partial class SearchModelFactory { - /// Initializes a new instance of AnswerResult. - /// The score value represents how relevant the answer is to the query relative to other answers returned for the query. - /// The key of the document the answer was extracted from. - /// The text passage extracted from the document contents as the answer. - /// Same text passage as in the Text property with highlighted text phrases most relevant to the query. - /// Additional Properties. - /// A new instance for mocking. - public static AnswerResult AnswerResult(double? score = null, string key = null, string text = null, string highlights = null, IReadOnlyDictionary additionalProperties = null) - { - additionalProperties ??= new Dictionary(); - - return new AnswerResult(score, key, text, highlights, additionalProperties); - } - - /// Initializes a new instance of CaptionResult. - /// A representative text passage extracted from the document most relevant to the search query. - /// Same text passage as in the Text property with highlighted phrases most relevant to the query. - /// Additional Properties. - /// A new instance for mocking. - public static CaptionResult CaptionResult(string text = null, string highlights = null, IReadOnlyDictionary additionalProperties = null) - { - additionalProperties ??= new Dictionary(); - - return new CaptionResult(text, highlights, additionalProperties); - } - - /// Initializes a new instance of DocumentDebugInfo. - /// Contains debugging information specific to semantic search queries. - /// A new instance for mocking. - public static DocumentDebugInfo DocumentDebugInfo(SemanticDebugInfo semantic = null) - { - return new DocumentDebugInfo(semantic); - } - - /// Initializes a new instance of SemanticDebugInfo. - /// The title field that was sent to the semantic enrichment process, as well as how it was used. - /// The content fields that were sent to the semantic enrichment process, as well as how they were used. - /// The keyword fields that were sent to the semantic enrichment process, as well as how they were used. - /// The raw concatenated strings that were sent to the semantic enrichment process. - /// A new instance for mocking. - public static SemanticDebugInfo SemanticDebugInfo(QueryResultDocumentSemanticField titleField = null, IEnumerable contentFields = null, IEnumerable keywordFields = null, QueryResultDocumentRerankerInput rerankerInput = null) - { - contentFields ??= new List(); - keywordFields ??= new List(); - - return new SemanticDebugInfo(titleField, contentFields?.ToList(), keywordFields?.ToList(), rerankerInput); - } - - /// Initializes a new instance of QueryResultDocumentSemanticField. - /// The name of the field that was sent to the semantic enrichment process. - /// The way the field was used for the semantic enrichment process (fully used, partially used, or unused). - /// A new instance for mocking. - public static QueryResultDocumentSemanticField QueryResultDocumentSemanticField(string name = null, SemanticFieldState? state = null) - { - return new QueryResultDocumentSemanticField(name, state); - } - - /// Initializes a new instance of QueryResultDocumentRerankerInput. - /// The raw string for the title field that was used for semantic enrichment. - /// The raw concatenated strings for the content fields that were used for semantic enrichment. - /// The raw concatenated strings for the keyword fields that were used for semantic enrichment. - /// A new instance for mocking. - public static QueryResultDocumentRerankerInput QueryResultDocumentRerankerInput(string title = null, string content = null, string keywords = null) - { - return new QueryResultDocumentRerankerInput(title, content, keywords); - } - - /// Initializes a new instance of AutocompleteResults. - /// A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request. - /// The list of returned Autocompleted items. - /// A new instance for mocking. - public static AutocompleteResults AutocompleteResults(double? coverage = null, IEnumerable results = null) - { - results ??= new List(); - - return new AutocompleteResults(coverage, results?.ToList()); - } - /// Initializes a new instance of SearchIndexerStatus. /// Overall indexer status. /// The result of the most recent or an in-progress indexer execution. @@ -191,5 +113,83 @@ public static SearchServiceCounters SearchServiceCounters(SearchResourceCounter return new SearchServiceCounters(aliasCounter, documentCounter, indexCounter, indexerCounter, dataSourceCounter, storageSizeCounter, synonymMapCounter, skillsetCounter, vectorIndexSizeCounter); } + + /// Initializes a new instance of AnswerResult. + /// The score value represents how relevant the answer is to the query relative to other answers returned for the query. + /// The key of the document the answer was extracted from. + /// The text passage extracted from the document contents as the answer. + /// Same text passage as in the Text property with highlighted text phrases most relevant to the query. + /// Additional Properties. + /// A new instance for mocking. + public static AnswerResult AnswerResult(double? score = null, string key = null, string text = null, string highlights = null, IReadOnlyDictionary additionalProperties = null) + { + additionalProperties ??= new Dictionary(); + + return new AnswerResult(score, key, text, highlights, additionalProperties); + } + + /// Initializes a new instance of CaptionResult. + /// A representative text passage extracted from the document most relevant to the search query. + /// Same text passage as in the Text property with highlighted phrases most relevant to the query. + /// Additional Properties. + /// A new instance for mocking. + public static CaptionResult CaptionResult(string text = null, string highlights = null, IReadOnlyDictionary additionalProperties = null) + { + additionalProperties ??= new Dictionary(); + + return new CaptionResult(text, highlights, additionalProperties); + } + + /// Initializes a new instance of DocumentDebugInfo. + /// Contains debugging information specific to semantic ranking requests. + /// A new instance for mocking. + public static DocumentDebugInfo DocumentDebugInfo(SemanticDebugInfo semantic = null) + { + return new DocumentDebugInfo(semantic); + } + + /// Initializes a new instance of SemanticDebugInfo. + /// The title field that was sent to the semantic enrichment process, as well as how it was used. + /// The content fields that were sent to the semantic enrichment process, as well as how they were used. + /// The keyword fields that were sent to the semantic enrichment process, as well as how they were used. + /// The raw concatenated strings that were sent to the semantic enrichment process. + /// A new instance for mocking. + public static SemanticDebugInfo SemanticDebugInfo(QueryResultDocumentSemanticField titleField = null, IEnumerable contentFields = null, IEnumerable keywordFields = null, QueryResultDocumentRerankerInput rerankerInput = null) + { + contentFields ??= new List(); + keywordFields ??= new List(); + + return new SemanticDebugInfo(titleField, contentFields?.ToList(), keywordFields?.ToList(), rerankerInput); + } + + /// Initializes a new instance of QueryResultDocumentSemanticField. + /// The name of the field that was sent to the semantic enrichment process. + /// The way the field was used for the semantic enrichment process (fully used, partially used, or unused). + /// A new instance for mocking. + public static QueryResultDocumentSemanticField QueryResultDocumentSemanticField(string name = null, SemanticFieldState? state = null) + { + return new QueryResultDocumentSemanticField(name, state); + } + + /// Initializes a new instance of QueryResultDocumentRerankerInput. + /// The raw string for the title field that was used for semantic enrichment. + /// The raw concatenated strings for the content fields that were used for semantic enrichment. + /// The raw concatenated strings for the keyword fields that were used for semantic enrichment. + /// A new instance for mocking. + public static QueryResultDocumentRerankerInput QueryResultDocumentRerankerInput(string title = null, string content = null, string keywords = null) + { + return new QueryResultDocumentRerankerInput(title, content, keywords); + } + + /// Initializes a new instance of AutocompleteResults. + /// A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request. + /// The list of returned Autocompleted items. + /// A new instance for mocking. + public static AutocompleteResults AutocompleteResults(double? coverage = null, IEnumerable results = null) + { + results ??= new List(); + + return new AutocompleteResults(coverage, results?.ToList()); + } } } diff --git a/sdk/search/Azure.Search.Documents/src/autorest.md b/sdk/search/Azure.Search.Documents/src/autorest.md index 871708384c3d..8b3694f5d833 100644 --- a/sdk/search/Azure.Search.Documents/src/autorest.md +++ b/sdk/search/Azure.Search.Documents/src/autorest.md @@ -10,9 +10,8 @@ See the [Contributing guidelines](https://github.com/Azure/azure-sdk-for-net/blo ## Swagger Source(s) ```yaml title: SearchServiceClient -input-file: - - https://github.com/Azure/azure-rest-api-specs/blob/b62ddd0ffb844fbfb688a04546800d60645a18ef/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchindex.json - - https://github.com/Azure/azure-rest-api-specs/blob/b62ddd0ffb844fbfb688a04546800d60645a18ef/specification/search/data-plane/Azure.Search/preview/2023-10-01-Preview/searchservice.json +require: +- /mnt/vss/_work/1/s/azure-rest-api-specs/specification/search/data-plane/Azure.Search/readme.md generation1-convenience-client: true deserialize-null-collection-as-null-value: true ``` @@ -409,3 +408,4 @@ directive: "modelAsString": false } ``` +